Skip to content
This repository has been archived by the owner on Jan 9, 2023. It is now read-only.

Latest commit

 

History

History

cli

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
bin
bin
 
 
lib
lib
 
 
src
src
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.npmrc
.npmrc
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

github-artifact-exporter

Exporter for GitHub

Usage

This script requires a personal access token with access to the repository you are exporting from. The owner and repo arguments can be found in the repository url.

See the table below for examples of owner and repo

Description URL owner repo
GitHub.com example https://github.com/foo/bar foo bar
GitHub Enterprise example https://ghe.host/foo/bar foo bar 
$ npm install -g @github/github-artifact-exporter-cli
$ github-artifacts-exporter COMMAND
running command...
$ github-artifacts-exporter (-v|--version|version)
@github/github-artifact-exporter-cli/2.0.2 darwin-x64 node-v14.4.0
$ github-artifacts-exporter --help [COMMAND]
USAGE
  $ github-artifacts-exporter COMMAND
...

Examples

Exporting issues

github-artifact-exporter.exe search:issues --owner github --repo caseflow --token <github-token> --since 2020-06-01 --until 2020-06-08 --format CSV > issue_export.csv

Exporting closed issues with specific labels

github-artifact-exporter.exe search:issues --owner github --repo caseflow --token <github-token> --state closed --updatedSince 2020-06-01 --updatedUntil 2020-06-08 --labels "Type: Bug" --format CSV > issue_export.csv

Exporting commits

github-artifact-exporter.exe repo:commits --owner github --repo caseflow --token <github-token> --since 2020-06-01 --until 2020-06-08 --format CSV > commit_export.csv

Exporting pull requests

github-artifact-exporter.exe repo:pulls --owner github --repo caseflow --token $GITHUB_TOKEN --format CSV > pulls_export.csv

Commands

github-artifacts-exporter help [COMMAND]

display help for github-artifacts-exporter

USAGE
  $ github-artifacts-exporter help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

github-artifacts-exporter repo

Export GitHub artifacts from a repository

USAGE
  $ github-artifacts-exporter repo

OPTIONS
  --baseUrl=baseUrl          [default: https://api.github.com] GitHub base url
  --format=(JSONL|JSON|CSV)  [default: JSONL] export format
  --owner=owner              GitHub repository owner
  --repo=repo                GitHub repository name
  --token=token              (required) GitHub personal access token

See code: src/commands/repo.ts

github-artifacts-exporter repo:commits

Export GitHub Commits for a repository

USAGE
  $ github-artifacts-exporter repo:commits

OPTIONS
  --baseUrl=baseUrl          [default: https://api.github.com] GitHub base url
  --branch=branch            [default: master] git branch to export commits for
  --format=(JSONL|JSON|CSV)  [default: JSONL] export format
  --owner=owner              GitHub repository owner
  --repo=repo                GitHub repository name
  --since=since              search commits created after yyyy-mm-dd
  --token=token              (required) GitHub personal access token
  --until=until              search commits created before yyyy-mm-dd

See code: src/commands/repo/commits.ts

github-artifacts-exporter repo:milestones

Export GitHub Milestones for a repository

USAGE
  $ github-artifacts-exporter repo:milestones

OPTIONS
  --baseUrl=baseUrl          [default: https://api.github.com] GitHub base url
  --format=(JSONL|JSON|CSV)  [default: JSONL] export format
  --owner=owner              GitHub repository owner
  --repo=repo                GitHub repository name
  --token=token              (required) GitHub personal access token

See code: src/commands/repo/milestones.ts

github-artifacts-exporter repo:projects

Export GitHub Milestones for a repository

USAGE
  $ github-artifacts-exporter repo:projects

OPTIONS
  --baseUrl=baseUrl              [default: https://api.github.com] GitHub base url
  --format=(JSONL|JSON|CSV)      [default: JSONL] export format
  --owner=owner                  GitHub repository owner
  --projectNumber=projectNumber  Project number from where to pull cards
  --repo=repo                    GitHub repository name
  --token=token                  (required) GitHub personal access token

See code: src/commands/repo/projects.ts

github-artifacts-exporter repo:pulls

Export GitHub Pull Requests for a repository

USAGE
  $ github-artifacts-exporter repo:pulls

OPTIONS
  --baseUrl=baseUrl          [default: https://api.github.com] GitHub base url
  --format=(JSONL|JSON|CSV)  [default: JSONL] export format
  --owner=owner              (required) GitHub repository owner
  --repo=repo                (required) GitHub repository name
  --since=since              search pull requests created after yyyy-mm-dd
  --token=token              (required) GitHub personal access token
  --until=until              search pull requests created before yyyy-mm-dd

See code: src/commands/repo/pulls.ts

github-artifacts-exporter repo:releases

Export GitHub Releases for a repository

USAGE
  $ github-artifacts-exporter repo:releases

OPTIONS
  --baseUrl=baseUrl          [default: https://api.github.com] GitHub base url
  --format=(JSONL|JSON|CSV)  [default: JSONL] export format
  --owner=owner              GitHub repository owner
  --repo=repo                GitHub repository name
  --token=token              (required) GitHub personal access token

See code: src/commands/repo/releases.ts

github-artifacts-exporter search

GitHub Search base command

USAGE
  $ github-artifacts-exporter search

OPTIONS
  --baseUrl=baseUrl          [default: https://api.github.com] GitHub base url
  --format=(JSONL|JSON|CSV)  [default: JSONL] export format
  --owner=owner              GitHub repository owner
  --repo=repo                GitHub repository name
  --token=token              (required) GitHub personal access token

See code: src/commands/search.ts

github-artifacts-exporter search:issues

Export GitHub Issues using Search

USAGE
  $ github-artifacts-exporter search:issues

OPTIONS
  --baseUrl=baseUrl            [default: https://api.github.com] GitHub base url
  --dateFormat=dateFormat      [default: isoDateTime] Date format to use when building issue list.  Examples: mm/dd/yyyy
  --format=(JSONL|JSON|CSV)    [default: JSONL] export format
  --jira                       transform output into a usable format for importing to Jira
  --labels=labels              search issues with these labels (comma seperated)
  --owner=owner                GitHub repository owner
  --query=query                Search query matching GitHub issue search syntax
  --repo=repo                  GitHub repository name
  --since=since                search issues created after yyyy-mm-dd
  --state=(open|closed)        search issues in this state
  --token=token                (required) GitHub personal access token
  --until=until                search issues created before yyyy-mm-dd
  --updatedSince=updatedSince  search issues updated after yyyy-mm-dd
  --updatedUntil=updatedUntil  search issues updated before yyyy-mm-dd

See code: src/commands/search/issues.ts