1. dumplingh(1)
  2. dumplingh(1)

NAME

dumplingh - Issue/PR exporter for GitHub

SYNOPSIS

dumplingh OPTIONS REPO_SLUG

DESCRIPTION

Issue/PR exporter for GitHub, which is a fancy name for dump issue and PR data to a JSON file.

Exit values and possible errors:

1 - I/O error
2 - parsing error

OPTIONS

REPO_SLUG

Repository to export issues and PRs for in the form
"<username>/<repo>".

-i --issues ISSUES_FILE

File to export issues to.

File must either not exist or --force must be specified.

Exclusive with --no-issues.

Default: `./<REPO_SLUG>-issues.json`.

-p --pulls PULLS_FILE

File to export pull requests to.

File must either not exist or --force must be specified.

Exclusive with --no-pulls.

Default: ./<REPO_SLUG>-pulls.json.

-l --labels LABELS_FILE

File to export labels to.

File must either not exist or --force must be specified.

Exclusive with --no-labels.

Default: `./<REPO_SLUG>-labels.json`.

-m --milestones MILESTONES_FILE

File to export milestones to.

File must either not exist or --force must be specified.

Exclusive with --no-milestones.

Default: `./<REPO_SLUG>-milestones.json`.

--projects PROJECTS_FILE

File to export projects to.

File must either not exist or --force must be specified.

Exclusive with --no-projects.

Requires --auth, since GitHub fails on unauthorised requests to
experimental API endpoints.

Default: `./<REPO_SLUG>-projects.json`.

--comments COMMENTS_DIR

Directory to export comments to.

Directory must either not exist or --force must be specified.

Exclusive with --no-comments.

Default: `./<REPO_SLUG>-comments`.

--no-issues

Don't export issues.

--no-pulls

Don't export pull requests.

--no-labels

Don't export labels.

--no-milestones

Don't export milestones.

--no-projects

Don't export projects.

--no-comments

Don't export comments.

-f --force

Allow for overriding <ISSUES_FILE> and <PULLS_FILE>.

-c --compact

Compact-print, rather than pretty-print the exported issues/pull requests.

-a --auth [OAUTH2_TOKEN]

Token to authenticate to GitHub with.

Recommended for more requests.

Required for --projects.

AUTHOR

Written by nabijaczleweli <nabijaczleweli@gmail.com>

Instigated by Vendethiel <https://github.com/vendethiel>

REPORTING BUGS

<https://github.com/nabijaczleweli/dumplingh/issues>

SEE ALSO

<https://github.com/nabijaczleweli/dumplingh>

  1. dumplingh developers
  2. December 2018
  3. dumplingh(1)