# create-from-repo

> create-from-repo is a tool for creating a new project by downloading from an existing git repo.

Latest version **0.1.2** (published 2020-12-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install create-from-repo
pnpm add create-from-repo
yarn add create-from-repo
bun add create-from-repo
```

Provides the command `create-from-repo`.

## 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.1.2 |
| Published | 2020-12-22 |
| First published | 2018-09-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 40 KB |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| Author | Bob |
| Maintainers | shixiaobao17145 |

## Links

- npm: https://www.npmjs.com/package/create-from-repo
- npm.io page: https://npm.io/package/create-from-repo

## Dependencies (7)

- [bl](https://npm.io/package/bl.md) >=1.2.3
- [ini](https://npm.io/package/ini.md) >=1.3.6
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [download](https://npm.io/package/download.md) ^7.1.0
- [commander](https://npm.io/package/commander.md) ^2.17.1
- [git-clone](https://npm.io/package/git-clone.md) ^0.1.0
- [decompress](https://npm.io/package/decompress.md) >=4.2.1

## Recent versions

- 0.1.2 (latest) — 2020-12-22
- 0.1.1 — 2018-09-02
- 0.0.5 — 2018-09-02

## README

# create-from-repo

create-from-repo is a tool for creating a new project by downloading from an existing git repo.


## Install

	npm install -g create-from-repo

## Usage

	create-from-repo [options] <repo-url> <download-target>

    -b, --branch <branch>  branch of the git repository (default: master)
    -t, --tag <tag>        specify the tag instead of branch of the git repository
    -s, --ssh              use your local ssh-key credential to download the repository
    --force                force to download regardless the target dir is not empty
    -h, --help             output usage information

## Examples

	create-from-repo https://github.com/shixiaobao17145/create-from-repo.git .

or

	create-from-repo git@github.com:shixiaobao17145/create-from-repo.git .

or 

	create-from-repo shixiaobao17145/create-from-repo .

It will download the create-from-repo to current dir. It will also work in other domain in the full-url mode, like `create-from-repo https://gitee.com/bobshi/create-from-repo .`

If the repo you're downloading is not a public one, you can add -s option to apply you local ssh cridential to download it by using the git clone command.

**Note**: the target directory should be a nonexist one or be an empty one, nevertheless you can add --force option to force it download to an exist folder, whereas --force would not work in ssh mode(with -s option) due to the native git clone command restriction;

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