githelp

CLI for performing routine operations with git

Install

$ npm i githelp -g

Usage

$ githelp --help

Help output:

githelp <command>

Commands:
  githelp add                Add changes to the index in all repositories located in the source directory
  githelp checkout <branch>  Switch branches in all repositories located in the source directory
  githelp clone              Clone all repositories available to you by access token to the output directory
  githelp commit             Commit changes to the index in all repositories located in the source directory
  githelp merge-request      Create merge request in all repositories located in the source directory
  githelp pull               For all repositories located in the source directory changes from their remote repositories will be pulled
  githelp push               For all repositories located in the source directory push commited changes to appropriate remote repositories

Options:
  --version   Show version number  [boolean]
  -h, --help  Show help  [boolean]

Available commands

• add
• checkout
• clone
• commit
• merge-request
• pull
• push

add

$ githelp add --help

Help output:

githelp add

Add changes to the index in all repositories located in the source directory

Options:
  --version      Show version number  [boolean]
  -v, --verbose  Show details about the result of running command  [boolean] [default: true]
  -s, --source   The directory where the repositories are located  [string] [default: "."]
  -h, --help     Show help  [boolean]

Examples:
  '$ githelp add'  Add changes to the index

checkout

$ githelp checkout --help

Help output:

githelp checkout <branch>

Switch branches in all repositories located in the source directory

Options:
  --version      Show version number  [boolean]
  -v, --verbose  Show details about the result of running command  [boolean] [default: true]
  -s, --source   The directory where the repositories are located  [string] [default: "."]
  -b             Apply -b flag to the 'git checkout' command if specified <branch> is not exists  [boolean] [default: false]
  -h, --help     Show help  [boolean]

Examples:
  '$ githelp checkout staging -b'  Switch branch to staging (if staging is not exists, it will be created)

clone

$ githelp clone --help

Help output:

githelp clone

Clone all repositories available to you by access token to the output directory

Options:
  --version           Show version number  [boolean]
  -v, --verbose       Show details about the result of running command  [boolean] [default: true]
  -t, --access_token  Access token (now provide only gitlab access token)  [string] [required]
  --api_url           API URL (now provide only gitlab API). Examples of correct API URL's:
                        - https://gitlab.com/api/v4
                        - https://gitlab.example.xyz/api/v4
                        - gitlab.com
                        - gitlab.example.xyz  [string] [default: "https://gitlab.com/api/v4"]
  -o, --output        Output directory  [string] [default: "./output"]
  -p, --page          Page number  [number] [default: 1]
  --per_page          Number of items to list per page  [number] [default: 20]
  -g, --group         Clone only repositories of the specified group  [string]
  -u, --user          Clone only repositories of the specified user  [string]
  -a, --all           Clone all available repositories ('page' and 'per_page' options will be ignored)  [boolean] [default: false]
  -f, --force         Folders located in the output directory and having the same names as the cloned repositories will be deleted before cloning  [boolean] [default: false]
  --visibility        Visibility level (now provide only gitlab visibility levels: public, internal or private)  [string] [choices: "public", "internal", "private"] [default: "private"]
  -h, --help          Show help  [boolean]

Examples:
  '$ githelp clone --user=eliseevNP -t 3FQtg-vF8cNjkSr2X9vc'  Clone all private repositories belongs to the 'eliseevNP' user

commit

$ githelp commit --help

Help output:

githelp commit

Commit changes to the index in all repositories located in the source directory

Options:
  --version      Show version number  [boolean]
  -v, --verbose  Show details about the result of running command  [boolean] [default: true]
  -s, --source   The directory where the repositories are located  [string] [default: "."]
  -m, --message  Commit message  [string] [required]
  -h, --help     Show help  [boolean]

Examples:
  '$ githelp commit -m message'  Commit changes with the specified message

merge-request

$ githelp merge-request --help

Help output:

githelp merge-request

Create merge request in all repositories located in the source directory

Options:
  --version               Show version number  [boolean]
  -v, --verbose           Show details about the result of running command  [boolean] [default: true]
  -t, --access_token      Access token (now provide only gitlab access token)  [string] [required]
  -s, --source            The directory where the repositories are located  [string] [default: "."]
  --api_url               API URL (now provide only gitlab API). Examples of correct API URL's:
                            - https://gitlab.com/api/v4
                            - https://gitlab.example.xyz/api/v4
                            - gitlab.com
                            - gitlab.example.xyz  [string] [default: "https://gitlab.com/api/v4"]
  --source_branch         The source branch  [string] [required]
  --target_branch         The target branch  [string] [required]
  --title                 Title of MR  [string] [required]
  --remove_source_branch  Flag indicating if a merge request should remove the source branch when merging  [boolean] [default: true]
  --squash                Squash commits into a single commit when merging  [boolean] [default: true]
  -h, --help              Show help  [boolean]

Examples:
  '$ githelp merge-request --target_branch=staging --source_branch=hot-fix --title="WIP: hot fix" -t 3FQtg-vF8cNjkSr2X9vc'  Create MR from hot-fix to staging with specified title

pull

$ githelp pull --help

Help output:

githelp pull

For all repositories located in the source directory changes from their remote repositories will be pulled

Options:
  --version      Show version number  [boolean]
  -v, --verbose  Show details about the result of running command  [boolean] [default: true]
  -s, --source   The directory where the repositories are located  [string] [default: "."]
  -h, --help     Show help  [boolean]

Examples:
  '$ githelp pull'  Pull changes

push

$ githelp push --help

Help output:

githelp push

For all repositories located in the source directory push commited changes to appropriate remote repositories

Options:
  --version      Show version number  [boolean]
  -v, --verbose  Show details about the result of running command  [boolean] [default: true]
  -s, --source   The directory where the repositories are located  [string] [default: "."]
  -h, --help     Show help  [boolean]

Examples:
  '$ githelp push'  Push changes

License

MIT.