# gin-tonic

> ship sync and hot reloading for urbit development

Latest version **0.5.0** (published 2023-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install gin-tonic
pnpm add gin-tonic
yarn add gin-tonic
bun add gin-tonic
```

Provides the command `gin`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2023-05-12 |
| First published | 2022-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 16.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | arthyn |
| Maintainers | nocsyx-lassul |

## Links

- npm: https://www.npmjs.com/package/gin-tonic
- Repository: https://github.com/arthyn/gin-tonic
- Homepage: https://github.com/arthyn/gin-tonic#readme
- Issues: https://github.com/arthyn/gin-tonic/issues
- npm.io page: https://npm.io/package/gin-tonic

## Dependencies (9)

- [conf](https://npm.io/package/conf.md) ^10.2.0
- [axios](https://npm.io/package/axios.md) ^1.1.2
- [chalk](https://npm.io/package/chalk.md) ^5.1.0
- [prompts](https://npm.io/package/prompts.md) ^2.4.2
- [signale](https://npm.io/package/signale.md) ^1.4.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [commander](https://npm.io/package/commander.md) ^9.4.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.2.10
- [node-watch](https://npm.io/package/node-watch.md) ^0.7.3

## Recent versions

- 0.5.0 (latest) — 2023-05-12
- 0.4.0 — 2022-11-05
- 0.2.2 — 2022-10-13
- 0.2.1 — 2022-10-12
- 0.2.0 — 2022-10-12
- 0.1.0 — 2022-10-12

## README

# gin and tonic

Two companions making [sail](https://developers.urbit.org/guides/additional/sail) 
development much nicer.

**gin**: a utility for syncing files from a repository to a clay desk and
committing on save.

**tonic**: a library which auto refreshes your sail page on commit

## getting started

1. First you should install `gin`:
   ```bash
   npm i -g gin-tonic
   ```
2. Next run `gin add` to add a workspace which will be used to sync your 
   files from your repository to the Urbit you're working on and commit.
3. Then run `gin pour` to add the tonic library to your Urbit.
4. Integrate tonic into your gall application by wrapping your gall agent:
   ```hoon
    /+  tonic
    ...
    %-  agent:tonic
    |_  =bowl:gall
    ...
   ```
5. Include tonic's script in each sail page:
  ```hoon
  /+  tonic
  ...
  ;head
    ...
    ;+  (inject:tonic q.byk.bowl)
  ==
  ```
6. Finally run `gin watch` and pick your workspace. Gin will run until
   cancelled syncing your changes.
7. Sip and enjoy!

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