# cranch

> Craete branch with a random name

Latest version **0.2.3** (published 2023-12-17) · MIT license · 0 weekly downloads

## Install

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

Provides the commands `c`, `cranch`.

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2023-12-17 |
| First published | 2022-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 3 |
| Unpacked size | 7.6 KB |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| Author | Yukiniro |
| Maintainers | yukiniro |
| Keywords | checkout, branch |

## Links

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

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) 5.1.2
- [nanoid](https://npm.io/package/nanoid.md) ^4.0.0
- [commander](https://npm.io/package/commander.md) ^9.4.1

## Recent versions

- 0.2.3 (latest) — 2023-12-17
- 0.2.2 — 2023-12-17
- 0.2.1 — 2023-12-17
- 0.1.5 — 2023-12-17
- 0.1.4 — 2022-12-05
- 0.1.3 — 2022-12-05
- 0.1.2 — 2022-12-05
- 0.1.1 — 2022-12-05
- 0.1.0 — 2022-12-05

## README

# cranch

![NPM](https://img.shields.io/npm/l/cranch?color=blue&style=flat-square) ![npm](https://img.shields.io/npm/v/cranch?color=blue&style=flat-square)

## Why cranch?

Ever found yourself spending more time brainstorming the perfect branch name than actually coding? If so, you just need to type `c` or `cranch`.

```shell
c
```

or

```shell
cranch
```

## Intro

`cranch` is a tiny library to create a random branch name. You know, it is a very difficult thing to think of a great name.

## Install

```shell
npm install cranch -g
```

## Options

`cranch` support some option to create a prefix name.

```shell
cranch -f
```

It will checkout a branch named `feat-xxxxxx`.

### -f or --feat

```shell
cranch [-f --feat]
```

`feat-xxxxxx`

### -fi or --fix

```shell
cranch [-fi --fix]
```

`fix-xxxxxx`

### -d or --doc

```shell
cranch [-d --doc]
```

`doc-xxxxxx`

### -s or --style

```shell
cranch [-s --style]
```

`style-xxxxxx`

### -r or --refactor

```shell
cranch [-r --refactor]
```

`refactor-xxxxxx`

### -p or --perf

```shell
cranch [-f --perf]
```

`perf-xxxxxx`

### -t or --test

```shell
cranch [-t --test]
```

`test-xxxxxx`

### -c or --chore

```shell
cranch [-c --chore]
```

`chore-xxxxxx`

### -r or --revert

```shell
cranch [-rv --revert]
```

`revert-xxxxxx`

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