# git-ss

> Save a snapshot of a directory to git

Latest version **0.1.6** (published 2022-04-09) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2022-04-09 |
| First published | 2021-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=14 |
| Dependencies | 11 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 (+7 in 2 direct dependencies) |
| Install scripts | no |
| Author | E. Hosso |
| Maintainers | hosobot |
| Keywords | git, github, backup, snapshot |

## Links

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

## Dependencies (11)

- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [execa](https://npm.io/package/execa.md) ^5.1.1
- [globby](https://npm.io/package/globby.md) 11
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [is-audio](https://npm.io/package/is-audio.md) ^0.0.0
- [is-image](https://npm.io/package/is-image.md) ^3.0.0
- [is-video](https://npm.io/package/is-video.md) ^1.0.1
- [is-archive](https://npm.io/package/is-archive.md) ^2.0.0
- [simple-git](https://npm.io/package/simple-git.md) ^2.45.0
- [unzip-stream](https://npm.io/package/unzip-stream.md) ^0.3.1
- [is-binary-path](https://npm.io/package/is-binary-path.md) ^2.1.0

## Recent versions

- 0.1.6 (latest) — 2022-04-09
- 0.1.5 — 2022-04-09
- 0.1.4 — 2022-03-12
- 0.1.3 — 2021-09-19
- 0.1.2 — 2021-09-18
- 0.1.1 — 2021-09-18
- 0.1.0 — 2021-09-04

## README

# git-ss

Save a snapshot of a directory to git.

## Installation

```sh
npm install git-ss
# or
yarn add git-ss
```

## Usage

### CommonJS

```js
const { pushToGit } = require('git-ss');

async function takeSnapshot() {
  await pushToGit('./mydata', 'https://github.com/hosso/mybackup.git');
}

takeSnapshot();
```

### TypeScript

```ts
import { pushToGit } from 'git-ss';

async function takeSnapshot() {
  await pushToGit('./mydata', 'https://github.com/hosso/mybackup.git');
}

takeSnapshot();
```

## License

[MIT](LICENSE)

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