github-automation
v5.3.3
Published
A github automation CLI for repetitive works
Downloads
74
Readme
github automation CLI interface.
oclif github-automation CLI:
Usage
$ npm install -g github-automation
$ github-automation COMMAND
running command...
$ github-automation (--version)
github-automation/5.3.3 linux-x64 node-v18.18.2
$ github-automation --help [COMMAND]
USAGE
$ github-automation COMMAND
...
Commands
github-automation help [COMMANDS]
github-automation list-org-repositories OWNER
github-automation mk-env -r REPOS -n NAMES -x VALUES
github-automation mk-repo -o ORG -r REPOS
github-automation create-environment -r REPOS -n NAMES -x VALUES
github-automation plugins
github-automation plugins:install PLUGIN...
github-automation plugins:inspect PLUGIN...
github-automation plugins:install PLUGIN...
github-automation plugins:link PLUGIN
github-automation plugins:uninstall PLUGIN...
github-automation plugins:uninstall PLUGIN...
github-automation plugins:uninstall PLUGIN...
github-automation plugins update
github-automation replace-in-files -r REPOS -n NAMES -x VALUES
github-automation remove-environment -r REPOS -n NAMES -x VALUES
github-automation rm-repo -o ORG -r REPOS
github-automation set-secret -r REPOS -n NAMES -x VALUES
github-automation branch-protection-rules -r REPOS -n NAMES -x VALUES
github-automation set-secret -e ENVIRONMENT -o OWNER -r REPOS -s NAMES->VALUES
github-automation set-vars -e ENV -r REPOS -o OWNER -v NAMES->VALUES
github-automation mk-repo -o ORG -r REPOS
github-automation help [COMMANDS]
Display help for github-automation.
USAGE
$ github-automation help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for github-automation.
See code: @oclif/plugin-help
github-automation list-org-repositories OWNER
List Org Repositories if have access
USAGE
$ github-automation list-org-repositories OWNER
FLAGS
-p, --page=<value> [default: 1] page number
DESCRIPTION
List Org Repositories if have access
EXAMPLES
$ github-automation ls OWNER
See code: dist/commands/ls/index.ts
github-automation mk-env -r REPOS -n NAMES -x VALUES
Create environments if not exist
USAGE
$ github-automation mk-env -r REPOS -n NAMES -x VALUES
FLAGS
-e, --environments=<value>... (required) If is set the env should be activated in the specified environment and
create it if not exist
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
DESCRIPTION
Create environments if not exist
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation mk-env --organization OWNER --repositories OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --environments ENVIRONMENTA ENVIRONMENTB
$ github-automation mk-env -o Owner -r OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --environments ENVIRONMENTA ENVIRONMENTB
See code: dist/commands/mk-env/index.ts
github-automation mk-repo -o ORG -r REPOS
Create repos
USAGE
$ github-automation mk-repo -o ORG -r REPOS
FLAGS
-b, --allBranches include All Branches
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
-t, --template=<value> a template name
DESCRIPTION
Create repos
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation mk-repo --organization OWNER --repositories NAME1 NAME2 ... NAMEn
$ github-automation mk-repo -o Owner -r NAME1 NAME2 ... NAMEn
See code: dist/commands/mk-repo/index.ts
github-automation create-environment -r REPOS -n NAMES -x VALUES
Remove environments if exist
USAGE
$ github-automation create-environment -r REPOS -n NAMES -x VALUES
FLAGS
-b, --branchNaming=<value> (required) branchfrom:branchto
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
DESCRIPTION
Remove environments if exist
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation rm-env --organization OWNER --repositories OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --environments ENVIRONMENTA ENVIRONMENTB
$ github-automation rm-env -o Owner -r OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --environments ENVIRONMENTA ENVIRONMENTB
See code: dist/commands/mv-branch/index.ts
github-automation plugins
List installed plugins.
USAGE
$ github-automation plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ github-automation plugins
See code: @oclif/plugin-plugins
github-automation plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ github-automation plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ github-automation plugins add
EXAMPLES
$ github-automation plugins:install myplugin
$ github-automation plugins:install https://github.com/someuser/someplugin
$ github-automation plugins:install someuser/someplugin
github-automation plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ github-automation plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ github-automation plugins:inspect myplugin
github-automation plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ github-automation plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ github-automation plugins add
EXAMPLES
$ github-automation plugins:install myplugin
$ github-automation plugins:install https://github.com/someuser/someplugin
$ github-automation plugins:install someuser/someplugin
github-automation plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ github-automation plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ github-automation plugins:link myplugin
github-automation plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ github-automation plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ github-automation plugins unlink
$ github-automation plugins remove
github-automation plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ github-automation plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ github-automation plugins unlink
$ github-automation plugins remove
github-automation plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ github-automation plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ github-automation plugins unlink
$ github-automation plugins remove
github-automation plugins update
Update installed plugins.
USAGE
$ github-automation plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
github-automation replace-in-files -r REPOS -n NAMES -x VALUES
Create environments if not exist
USAGE
$ github-automation replace-in-files -r REPOS -n NAMES -x VALUES
FLAGS
-b, --branch=<value> [default: main] Branch
-e, --email=<value> [default: [email protected]] Commiter Email
-f, --from=<value> (required) string to replace
-h, --help Show CLI help.
-m, --message=<value> [default: Replace in file] Commit Message
-n, --name=<value> [default: Jorge Saud] Commiter Name
-o, --organization=<value> (required) A single string containing the organization name
-p, --paths=<value>... (required) paths of files
-r, --repositories=<value>... (required) Can be multiples repositories names
-t, --to=<value> (required) string to replace
DESCRIPTION
Create environments if not exist
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation replace-in-files --organization OWNER --repositories OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --environments ENVIRONMENTA ENVIRONMENTB
$ github-automation replace-in-files -o Owner -r OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --environments ENVIRONMENTA ENVIRONMENTB
See code: dist/commands/replace-in-files/index.ts
github-automation remove-environment -r REPOS -n NAMES -x VALUES
Remove environments if exist
USAGE
$ github-automation remove-environment -r REPOS -n NAMES -x VALUES
FLAGS
-e, --environments=<value>... (required) If is set the env should be activated in the specified environment and
create it if not exist
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
DESCRIPTION
Remove environments if exist
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation rm-env --organization OWNER --repositories OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --environments ENVIRONMENTA ENVIRONMENTB
$ github-automation rm-env -o Owner -r OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --environments ENVIRONMENTA ENVIRONMENTB
See code: dist/commands/rm-env/index.ts
github-automation rm-repo -o ORG -r REPOS
Create repos
USAGE
$ github-automation rm-repo -o ORG -r REPOS
FLAGS
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
DESCRIPTION
Create repos
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation rm-repo --organization OWNER --repositories NAME1 NAME2 ... NAMEn
$ github-automation rm-repo -o Owner -r NAME1 NAME2 ... NAMEn
See code: dist/commands/rm-repo/index.ts
github-automation set-secret -r REPOS -n NAMES -x VALUES
Rempve Secrets
USAGE
$ github-automation set-secret -r REPOS -n NAMES -x VALUES
FLAGS
-e, --environment=<value> If is set the env should be activated in the specified environment and create it if not
exist
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
-s, --secrets=<value>... (required) Can be multiples secret names separated by space
DESCRIPTION
Rempve Secrets
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation set-secret -r OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn --secrets SECRET_NAME1:SECRET_VALUE_1 SECRET_NAME2:SECRET_VALUE_2 ... SECRET_NAMEN:SECRET_VALUE_N
$ github-automation set-secret -r OWNER/NAME1 OWNER/NAME2 ... OWNER/NAMEn -s SECRET_NAME1:SECRET_VALUE_1 SECRET_NAME2 ... SECRET_NAMEN -x SECRETVALUE1 SECRETVALUE2:SECRET_VALUE_2 ... SECRETVALUEN:SECRET_VALUE_N
See code: dist/commands/rm-secrets/index.ts
github-automation branch-protection-rules -r REPOS -n NAMES -x VALUES
Set Protected Branches and rules
USAGE
$ github-automation branch-protection-rules -r REPOS -n NAMES -x VALUES
FLAGS
-b, --branches=<value>... (required) Can be multiples repositories branches
-c, --passingChecks=<value>... Can be multiples checks to pass to the pr
-h, --help Show CLI help.
-l, --likes=<value> (required) [default: 2] Likes required in pr
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
DESCRIPTION
Set Protected Branches and rules
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation branch-protection-rules -r NAME1 NAME2 ... NAMEn -o ORG --secret-name SECRET_NAME1 SECRET_NAME2 ... SECRET_NAMEN --secret-value SECRETVALUE1 SECRETVALUE2 ... SECRETVALUEN
$ github-automation branch-protection-rules -r NAME1 NAME2 ... NAMEn -o ORG -n SECRET_NAME1 SECRET_NAME2 ... SECRET_NAMEN -x SECRETVALUE1 SECRETVALUE2 ... SECRETVALUEN
See code: dist/commands/set-protection-rules/index.ts
github-automation set-secret -e ENVIRONMENT -o OWNER -r REPOS -s NAMES->VALUES
Set Secrets in repo from org
USAGE
$ github-automation set-secret -e ENVIRONMENT -o OWNER -r REPOS -s NAMES->VALUES
FLAGS
-e, --environment=<value> If is set the env should be activated in the specified environment and create it if not
exist
-f, --forced If is set the env should be activated in the specified environment and create it if not
exist
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
-s, --secrets=<value>... (required) Can be multiples variable names separated by -> ej: name->variable
DESCRIPTION
Set Secrets in repo from org
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation set-secret --owner OWNER --repositories NAME1 NAME2 ... NAMEN --secrets NAME_1->SECRET_1 NAME_2->SECRET_2 ... NAME_N->SECRET_N
$ github-automation set-secret --environment ENVIRONMENT --owner OWNER --repositories NAME1 NAME2 ... NAMEN --secrets NAME_1->SECRET_1 NAME_2->SECRET_2 ... NAME_N->SECRET_N
$ github-automation set-secret -o OWNER -r NAME1 NAME2 ... NAMEN -s NAME_1->SECRET_1 NAME_2->SECRET_2 ... NAME_N->SECRET_N
$ github-automation set-secret -e ENVIRONMENT -o OWNER -r NAME1 NAME2 ... NAMEN -s NAME_1->SECRET_1 NAME_2->SECRET_2 ... NAME_N->SECRET_N
See code: dist/commands/set-secrets/index.ts
github-automation set-vars -e ENV -r REPOS -o OWNER -v NAMES->VALUES
Set Variables in repo from org
USAGE
$ github-automation set-vars -e ENV -r REPOS -o OWNER -v NAMES->VALUES
FLAGS
-e, --environment=<value> If is set the env should be activated in the specified environment and create it if not
exist
-f, --forced If is set the env should be activated in the specified environment and create it if not
exist
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-r, --repositories=<value>... (required) Can be multiples repositories names
-v, --variables=<value>... (required) Can be multiples variable names separated by -> ej: name->variable
DESCRIPTION
Set Variables in repo from org
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation set-vars --owner OWNER --repositories NAME1 NAME2 ... NAMEN --variables NAME_1->SECRET_1 NAME_2->SECRET_2 ... NAME_N->SECRET_N
$ github-automation set-vars --environment ENVIRONMENT --owner OWNER --repositories NAME1 NAME2 ... NAMEN --variables NAME_1->SECRET_1 NAME_2->SECRET_2 ... NAME_N->SECRET_N
$ github-automation set-vars -o OWNER -r NAME1 NAME2 ... NAMEN -v NAME_1->SECRET_1 NAME_2->SECRET_2 ... NAME_N->SECRET_N
$ github-automation set-vars -e ENVIRONMENT -o OWNER -r NAME1 NAME2 ... NAMEN -v NAME_1->SECRET_1 NAME_2->SECRET_2 ... NAME_N->SECRET_N
See code: dist/commands/set-vars/index.ts
github-automation mk-repo -o ORG -r REPOS
Update repos
USAGE
$ github-automation mk-repo -o ORG -r REPOS
FLAGS
-h, --help Show CLI help.
-o, --organization=<value> (required) A single string containing the organization name
-t, --template=<value> a template name
-u, --updateMetadata=<value> (required) update metadata
DESCRIPTION
Update repos
EXAMPLES
you must have a personal github token to set the first time that uses this tool
$ github-automation mk-repo --organization OWNER --repositories NAME1 NAME2 ... NAMEn
$ github-automation mk-repo -o Owner -r NAME1 NAME2 ... NAMEn
See code: dist/commands/update-repo/index.ts