# git-yoink

> Git utility for a Golang-inspired directory structure.

Latest version **1.1.0** (published 2022-04-20) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install git-yoink
pnpm add git-yoink
yarn add git-yoink
bun add git-yoink
```

Provides the command `git-yoink`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-04-20 |
| First published | 2021-06-19 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Kognise |
| Maintainers | archmaster |

## Links

- npm: https://www.npmjs.com/package/git-yoink
- Repository: https://github.com/kognise/git-yoink/
- npm.io page: https://npm.io/package/git-yoink

## Dependencies (1)

- [git-url-parse](https://npm.io/package/git-url-parse.md) ^11.6.0

## Recent versions

- 1.1.0 (latest) — 2022-04-20
- 1.0.1 — 2021-06-22
- 1.0.0 — 2021-06-19

## README

# git-yoink

a tiny git utility for golang-style directory structures.

for example, `git@github.com:kognise/water.css.git` will go into the folder structure `github.com/kognise/water.css`. this helps a lot with duplicate names and organization.

## installation

to install...

```sh
# NPM
npm install -g git-yoink

# Yarn v1
yarn global add git-yoink
```

i recommend adding a git alias as well so you can simply run `git yoink`...

```sh
git config --global alias.yoink '!git-yoink'
```

i personally have it aliased to `git get`.

## usage

just use it instead of your normal clone...

```sh
git yoink git@github.com:kognise/water.css.git
```

create an issue if you have any questions!

## config

all configuration is done via environment variables:

- **`GIT_YOINK_ROOT`**

	this is recommended! git-yoink will always clone everything into this directory instead of the working directory.

	example: `/Users/kognise/Documents/Programming/`

- **`GIT_YOINK_REGISTRY`**

	if you use a smart cd command like [zoxide](https://github.com/ajeetdsouza/zoxide/), you can set this to automatically add the cloned directory to make it easier to cd into. the command passed will be called after clone with the directory passed as an argument.

	example: `zoxide add`

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