stefanbuck-test-project
v1.0.0
Published
An Octoherd script to download files from repositories
Downloads
2
Readme
octoherd-script-download-files
An Octoherd script to download files from repositories
Usage
Minimal usage
npx octoherd-script-download-files \
--source README.md \
--target ./out
Pass all options as CLI flags to avoid user prompts
npx octoherd-script-download-files \
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
-R "stefanbuck/*" \
--source README.md \
--target ./out
Options
| option | type | description |
| --------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --source
| string | Required. Path to the destination directory |
| --target
| string | Required. File path to download. Note: Directories are not supported yet |
| --ignore-archived
or --no-ignore-archived
| boolean | Default true
. Ignores archive 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 |
Contributing
See CONTRIBUTING.md
About Octoherd
@octoherd is project to help you keep your GitHub repositories in line.