# cloen

> `git clone` wrapper. Clones a repository, cds into it, and opens it in $EDITOR|$GUI_EDITOR.

Latest version **0.1.3** (published 2018-01-19) · MIT license · 0 weekly downloads

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

## Install

```sh
npm install cloen
pnpm add cloen
yarn add cloen
bun add cloen
```

Provides the command `cloen`.

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2018-01-19 |
| First published | 2017-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kutsan Kaplan |
| Maintainers | kutsan |
| Keywords | git, clone, wrapper |

## Links

- npm: https://www.npmjs.com/package/cloen
- Repository: https://github.com/kutsan/cloen
- Homepage: https://github.com/kutsan/cloen#readme
- Issues: https://github.com/kutsan/cloen/issues
- npm.io page: https://npm.io/package/cloen

## Recent versions

- 0.1.3 (latest) — 2018-01-19
- 0.1.2 — 2018-01-19
- 0.1.1 — 2017-04-23
- 0.1.0 — 2017-04-07

## README

# cloen

`git clone` wrapper. Clones a repository, cds into it, and opens it in `$EDITOR`|`$GUI_EDITOR`.

Set `GITHUB_USERNAME` environment variable in your .bashrc, .zshrc or equivalent.
Example, `export GITHUB_USERNAME="username"`.

![Demonstration GIF](https://i.imgur.com/1EPYZF2.gif)

## Install

### npm

```
npm install cloen --global
```

### Manual

Take `bin/cloen` binary and put it somewhere that's in your `$PATH`.

## Synopsis

```
$ cloen [options] <repo-url|username/repo-name|own-repo-name>
```

## Options

#### `-n`

Don't use full name. Default is on. Normally, repositories clone into their
repository name with `<author>--<repo-name>` format. Like `$ cloen kutsan/dotfiles`
clones into `kutsan--dotfiles` directory. If this option specified, it clones into
`dotfiles` folder without dashes.

#### `-o`

Open editor, after clone finished. Default is off. If `$GUI_EDITOR` or `$EDITOR` globally
specified, then repository will open in it, as `$GUI_EDITOR` primacy. Otherwise, `vim`
will be used as default.

#### `-e <editor>`

Open with selected editor, after clone finished. No need extra `-o` flag. Note that,
editor executable must be under your `$PATH` and it must accept directory with its
first argument.

#### `-h --help`

Show help screen.

## Examples

```
$ cloen <repo-name>
	.. git clone git@github.com:<GITHUB_USERNAME>/<repo-name>.git <username>--<repo-name>
```

```
$ cloen -o <username>/<repo-name>
	.. git clone git@github.com:<username>/<repo-name>.git <username>--<repo-name>
	.. cd <username>--<repo-name>
	.. $EDITOR .
```

```
$ cloen git@github.com:<username>/<repo-name>.git (or HTTP(S) link)
	.. git clone git@github.com:<username>/<repo-name>.git <username>--<repo-name>
```

```
$ cloen -ne emacs <username>/<repo-name>
	.. git clone git@github.com:<username>/<repo-name>.git <repo-name>
	.. cd <repo-name>
	.. emacs .
```

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