Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

heroku/heroku-git

Repository files navigation

@heroku-cli/plugin-git

Heroku CLI plugin to manage local git repos.

Version CircleCI Downloads/week License

Usage

$ npm install -g @heroku-cli/plugin-git
$ oclif-example COMMAND
running command...
$ oclif-example (-v|--version|version)
@heroku-cli/plugin-git/3.0.2 darwin-x64 node-v10.1.0
$ oclif-example --help [COMMAND]
USAGE
  $ oclif-example COMMAND
...

Commands

oclif-example git:clone [DIRECTORY]

clones a heroku app to your local machine at DIRECTORY (defaults to app name)

USAGE
  $ oclif-example git:clone [DIRECTORY]

ARGUMENTS
  DIRECTORY  where to clone the app

OPTIONS
  -a, --app=app        (required) the Heroku app to use
  -r, --remote=remote  the git remote to create, default "heroku"
  --ssh-git            use SSH git protocol

EXAMPLES
  $ heroku git:clone -a example
  Cloning into 'example'...
  remote: Counting objects: 42, done.
  ...

See code: src/commands/git/clone.ts

oclif-example git:remote

adds a git remote to an app repo

USAGE
  $ oclif-example git:remote

OPTIONS
  -a, --app=app        the Heroku app to use
  -r, --remote=remote  the git remote to create
  --ssh-git            use SSH git protocol

DESCRIPTION
  extra arguments will be passed to git remote add


EXAMPLES
  # set git remote heroku to https://git.heroku.com/example.git
       $ heroku git:remote -a example

       # set git remote heroku-staging to https://git.heroku.com/example-staging.git
       $ heroku git:remote --remote heroku-staging -a example

See code: src/commands/git/remote.ts