The easiest way to download files from GitHub.
Minimal usage
npx octoherd-script-get-files \
--source README.md \
--output ./outPass all options as CLI flags to avoid user prompts
npx octoherd-script-get-files \
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
-R "octolinker/*" \
--source README.md \
--output ./out| option | type | description |
|---|---|---|
--source |
string | Required. File to download. This can also be a Glob see example. |
--output |
string | Required. Specify a path to place the downloaded file or directory (instead of using the current working directory). Directories specified in the path will be created by this command. |
--ignore-archived or --no-ignore-archived
|
boolean | Default true. Ignores archive repositories |
--ignore-forks or --no-ignore-forks
|
boolean | Default true. Ignores forked repositories |
--ignore-public or --no-ignore-public
|
boolean | Default false. Ignores public repositories |
--ignore-private or --no-ignore-private
|
boolean | Default false. Ignores private repositories |
--octoherd-token, -T
|
string | A personal access token (create). Script will create one if option is not set |
--octoherd-repos, -R
|
array of strings | One or multiple space-separated repositories in the form of repo-owner/repo-name. repo-owner/* will find all repositories for one owner. * will find all repositories the user has access to. Will prompt for repositories if not set |
--octoherd-bypass-confirms |
boolean | Bypass prompts to confirm mutating requests |
Download a single file
npx octoherd-script-get-files -R octolinker/octolinker --source=README.md --output=./outDownload a single file by full path
npx octoherd-script-get-files -R octolinker/octolinker --source=.github/PULL_REQUEST_TEMPLATE.md --output=./outDownload recursively all files with a certain file extension
npx octoherd-script-get-files -R octolinker/octolinker --source='**/*.html' --output=./outDownload recursively all files from a specific folder
npx octoherd-script-get-files -R octolinker/octolinker --source='.github/**/*' --output=./outDownload everything
npx octoherd-script-get-files -R octolinker/octolinker --source='**/*' --output=./outDon't know how to write Glob? Check out DigitalOcean's amazing Glob testing tool.
See CONTRIBUTING.md
@octoherd is project to help you keep your GitHub repositories in line.