# @heroku-cli/plugin-git

> Heroku CLI plugin to manage local git repos.

Latest version **8.1.8** (published 2023-06-14) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @heroku-cli/plugin-git
pnpm add @heroku-cli/plugin-git
yarn add @heroku-cli/plugin-git
bun add @heroku-cli/plugin-git
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 8.1.8 |
| Published | 2023-06-14 |
| First published | 2018-02-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14 |
| Dependencies | 4 |
| Unpacked size | 15.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 889 |
| Author | Jeff Dickey |
| Maintainers | heroku-front-end, bsperlingsf, zli-sf, 7ftz, joanneyeung, montes_heroku, jwadsworthsf, jheikes, lmckenzie, mhale_salesforce, sarassassin, pfuente, reidmix, mbuschheroku, k.plenty, eblack, sheax0r, k80bowman, rdagg-hero, grundy.g, robinson.m, tcareysmith-sfdc, ptemporini, paulaprado18, via7aazfntqmqqi, harish.457, ntonollier |
| Keywords | heroku-plugin |

## Links

- npm: https://www.npmjs.com/package/@heroku-cli/plugin-git
- Repository: https://github.com/heroku/cli
- Homepage: https://github.com/heroku/cli/tree/main/packages/git
- Issues: https://github.com/heroku/cli/issues
- npm.io page: https://npm.io/package/@heroku-cli/plugin-git

## Dependencies (4)

- [debug](https://npm.io/package/debug.md) 4.3.4
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1.26.2
- [@heroku-cli/color](https://npm.io/package/@heroku-cli/color.md) ^1.1.14
- [@heroku-cli/command](https://npm.io/package/@heroku-cli/command.md) 9.0.1

## Recent versions

- 8.1.8 (latest) — 2023-06-14
- 8.1.7-beta.0 (beta) — 2023-06-01
- 8.1.7 — 2023-06-01
- 8.1.6 — 2023-05-31
- 8.1.6-beta.0 — 2023-05-31
- 8.1.4 — 2023-05-24
- 8.1.4-beta.0 — 2023-05-11
- 8.1.0 — 2023-04-27
- 8.0.6 — 2023-04-24
- 8.0.5 — 2023-04-18
- 8.0.5-beta.1 — 2023-04-14
- 8.0.2 — 2023-03-20
- 8.0.2-beta.1 — 2023-03-16
- 8.0.2-beta.0 — 2023-03-15
- 7.68.0 — 2023-02-07
- … 66 more at https://npm.io/package/@heroku-cli/plugin-git/versions

## README

@heroku-cli/plugin-git
======================

Heroku CLI plugin to manage local git repos.

[![Version](https://img.shields.io/npm/v/@heroku-cli/plugin-git.svg)](https://npmjs.org/package/@heroku-cli/plugin-git)
[![CircleCI](https://circleci.com/gh/[object Object]/tree/master.svg?style=shield)](https://circleci.com/gh/[object Object]/tree/master)
[![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)
[![Downloads/week](https://img.shields.io/npm/dw/@heroku-cli/plugin-git.svg)](https://npmjs.org/package/@heroku-cli/plugin-git)
[![License](https://img.shields.io/npm/l/@heroku-cli/plugin-git.svg)](https://github.com/[object Object]/blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @heroku-cli/plugin-git
$ oclif-example COMMAND
running command...
$ oclif-example (--version|-v)
@heroku-cli/plugin-git/8.1.8 darwin-x64 node-v16.19.0
$ oclif-example --help [COMMAND]
USAGE
  $ oclif-example COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`oclif-example git:clone [DIRECTORY]`](#oclif-example-gitclone-directory)
* [`oclif-example git:remote`](#oclif-example-gitremote)

## `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] -a <value> [-r <value>]

ARGUMENTS
  DIRECTORY  where to clone the app

FLAGS
  -a, --app=<value>     (required) the Heroku app to use
  -r, --remote=<value>  the git remote to create, default "heroku"

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

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

_See code: [src/commands/git/clone.ts](https://github.com/heroku/cli/blob/v8.1.8/packages/git/src/commands/git/clone.ts)_

## `oclif-example git:remote`

adds a git remote to an app repo

```
USAGE
  $ oclif-example git:remote [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     the Heroku app to use
  -r, --remote=<value>  the git remote to create

DESCRIPTION
  adds a git remote to an app repo
  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.git
      $ heroku git:remote --remote heroku-staging -a example
```

_See code: [src/commands/git/remote.ts](https://github.com/heroku/cli/blob/v8.1.8/packages/git/src/commands/git/remote.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/@heroku-cli/plugin-git · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._