UNPKG

2.81 kBMarkdownView Raw
1@heroku-cli/plugin-git
2======================
3
4Heroku CLI plugin to manage local git repos.
5
6[![Version](https://img.shields.io/npm/v/@heroku-cli/plugin-git.svg)](https://npmjs.org/package/@heroku-cli/plugin-git)
7[![CircleCI](https://circleci.com/gh/[object Object]/tree/master.svg?style=shield)](https://circleci.com/gh/[object Object]/tree/master)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/[object Object]?branch=master&svg=true)](https://ci.appveyor.com/project/[object Object]/branch/master)
9[![Codecov](https://codecov.io/gh/[object Object]/branch/master/graph/badge.svg)](https://codecov.io/gh/[object Object])
10[![Downloads/week](https://img.shields.io/npm/dw/@heroku-cli/plugin-git.svg)](https://npmjs.org/package/@heroku-cli/plugin-git)
11[![License](https://img.shields.io/npm/l/@heroku-cli/plugin-git.svg)](https://github.com/[object Object]/blob/master/package.json)
12
13<!-- toc -->
14* [Usage](#usage)
15* [Commands](#commands)
16<!-- tocstop -->
17# Usage
18<!-- usage -->
19```sh-session
20$ npm install -g @heroku-cli/plugin-git
21$ oclif-example COMMAND
22running command...
23$ oclif-example (-v|--version|version)
24@heroku-cli/plugin-git/7.43.0 darwin-x64 node-v12.15.0
25$ oclif-example --help [COMMAND]
26USAGE
27 $ oclif-example COMMAND
28...
29```
30<!-- usagestop -->
31# Commands
32<!-- commands -->
33* [`oclif-example git:clone [DIRECTORY]`](#oclif-example-gitclone-directory)
34* [`oclif-example git:remote`](#oclif-example-gitremote)
35
36## `oclif-example git:clone [DIRECTORY]`
37
38clones a heroku app to your local machine at DIRECTORY (defaults to app name)
39
40```
41USAGE
42 $ oclif-example git:clone [DIRECTORY]
43
44ARGUMENTS
45 DIRECTORY where to clone the app
46
47OPTIONS
48 -a, --app=app (required) the Heroku app to use
49 -r, --remote=remote the git remote to create, default "heroku"
50 --ssh-git use SSH git protocol
51
52EXAMPLES
53 $ heroku git:clone -a example
54 Cloning into 'example'...
55 remote: Counting objects: 42, done.
56 ...
57```
58
59_See code: [src/commands/git/clone.ts](https://github.com/heroku/cli/blob/v7.43.0/packages/git/src/commands/git/clone.ts)_
60
61## `oclif-example git:remote`
62
63adds a git remote to an app repo
64
65```
66USAGE
67 $ oclif-example git:remote
68
69OPTIONS
70 -a, --app=app the Heroku app to use
71 -r, --remote=remote the git remote to create
72 --ssh-git use SSH git protocol
73
74DESCRIPTION
75 extra arguments will be passed to git remote add
76
77EXAMPLES
78 # set git remote heroku to https://git.heroku.com/example.git
79 $ heroku git:remote -a example
80
81 # set git remote heroku-staging to https://git.heroku.com/example-staging.git
82 $ heroku git:remote --remote heroku-staging -a example
83```
84
85_See code: [src/commands/git/remote.ts](https://github.com/heroku/cli/blob/v7.43.0/packages/git/src/commands/git/remote.ts)_
86<!-- commandsstop -->