# git-repo-clone

> git clone

Latest version **0.3.2** (published 2021-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install git-repo-clone
pnpm add git-repo-clone
yarn add git-repo-clone
bun add git-repo-clone
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2021-10-29 |
| First published | 2021-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 319.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Xmo |
| Maintainers | xmon |
| Keywords | git clone node nodejs typescript |

## Links

- npm: https://www.npmjs.com/package/git-repo-clone
- Repository: https://github.com/darkXmo/git-repo-clone
- Homepage: https://github.com/darkXmo/git-repo-clone#readme
- Issues: https://github.com/darkXmo/git-repo-clone/issues
- npm.io page: https://npm.io/package/git-repo-clone

## Dependencies (1)

- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.3.2 (latest) — 2021-10-29
- 0.3.1 — 2021-10-28
- 0.3.0 — 2021-10-04
- 0.2.0 — 2021-10-04
- 0.1.1 — 2021-10-03
- 0.1.0 — 2021-10-03

## README

# git-repo-clone ![npm license](https://img.shields.io/npm/l/git-repo-clone.svg?sanitize=true) ![npm version](https://img.shields.io/npm/v/git-repo-clone.svg?sanitize=true)

git clone 仓库，只实现 clone 用于解决 download-git-repo 中出现交互，则命令行无法直接卡死的问题。

## 安装

```bash
# yarn
yarn add git-repo-clone

# npm
npm install git-repo-clone
```

## 使用方法

```javascript
  function clone(
    gitHref: string,
    branch?: string | undefined,
    dir?: string | undefined,
    empty?: boolean
  ): Promise<string>;
```

- `gitHref`: git 地址，例如 `https://github.com/darkXmo/git-repo-clone.git` 或 `https://gitee.com/dXmo/xmo-cli.git` ;

- `branch`: git 分支，建议填写，例如 `master` 、 `development` 、 `production` 。

- `dir`: 本地位置，即将仓库放在本地哪个目录下，默认为 Git 仓库名。

- `empty`: clone 之后是否清空 `.git` 。

- 返回值：clone 下载的仓库的绝对地址，例如 `/home/xmo/code/git-repo-clone/testDirBranch` ;

### Examples

```javascript
import { clone } from "git-repo-clone";

clone("https://github.com/darkXmo/xmo-cli.git");

await clone("https://github.com/darkXmo/xmo-cli.git", "primary");

const dir = await clone(
  "https://github.com/darkXmo/xmo-cli.git",
  undefined,
  "localDir"
);

const dir: string = await clone(
  "https://github.com/darkXmo/xmo-cli.git",
  "primary",
  "localDir"
);

const dir: string = await clone(
  "https://github.com/darkXmo/xmo-cli.git",
  "primary",
  "localDir",
  true
);

const dir: string = await clone(
  "https://github.com/darkXmo/xmo-cli.git",
  undefined,
  undefined,
  true
);
```

> 如果需要使用 `dir` 参数又不想指定 `branch` ，就用 `undefined` 补全空位即可。

## 为什么不用 download-git-repo

download-git-repo 遇到

```bash
The authenticity of host 'github.com (20.205.243.166)' can't be established.
RSA key fingerprint is SHA256:xxxxxxxxxxxxxxxxxx.
```

无法启动交互，会卡死。

另外，`git-repo-clone` 使用 `typescript` 开发，类型检查更加到位。

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