# git-remote-gosh

> Git remote helper for Gosh

Latest version **1.0.0-beta.1** (published 2022-05-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install git-remote-gosh
pnpm add git-remote-gosh
yarn add git-remote-gosh
bun add git-remote-gosh
```

Provides the command `git-remote-gosh`.

## 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.0.0-beta.1 |
| Published | 2022-05-04 |
| First published | 2022-05-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 47.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tonlabs |
| Maintainers | 0x657665727363616c65 |

## Links

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

## Dependencies (2)

- [@eversdk/core](https://npm.io/package/@eversdk/core.md) ^1.32.0
- [@eversdk/lib-node](https://npm.io/package/@eversdk/lib-node.md) ^1.32.0

## Recent versions

- 1.0.0-beta.1 (latest) — 2022-05-04

## README

git-remote-gosh is a git-client helper to interact with remote repositories hosted on the Everscale blockchain networks

--

This Git helper used Everscale blockchain as a remote for Git.

## Remote

For correct usage of the helper you should use remote in form:

```
gosh[::<NETWORK>]://[<USER_ACCOUNT>@]GOSH_ROOT/REPO_NAME
```

Defaults values are following:

**NETWORK** - `main.ton.dev`

**USER_ACCOUNT** - `default`


### Examples:

For usage with local (Evernode SE)[https://github.com/tonlabs/evernode-se] remote may be as follows:

```
git clone gosh::net.ton.dev://0:08ff47a77ba853306d234f5803dc25e5a9128aa280df44889f7d64c69f81aec8/testrepo111
gosh::localhost://0:a6af961f2973bb00fe1d3d6cfee2f2f9c89897719c2887b31ef5ac4fd060638f/my-user-name/my-repo
```

## User account

To be able to push to Gosh repositories, you need to have a wallet on the Everscale blockchain. git-remote-gosh expects that the wallet credentials are in the file: `~/.gosh/credentials.json`:

```json
{
    "my-wallet": {
        "address": "0:d5f5cfc4b52d2eb1bd9d3a8e51707872c7ce0c174facddd0e06ae5ffd17d2fcd",
        "keys": {
            "public": "1234567890123456789012345678901234567890123456789012345678901234",
            "secret": "0987654321098765432109876543210987654321098765432109876543210987"
        }
    }
}
```

For usage of this wallet (main network as default) the remote may be as follows:

```
gosh://my-wallet@0:a6af961f2973bb00fe1d3d6cfee2f2f9c89897719c2887b31ef5ac4fd060638f/my-user-name/my-repo
```

## Setup helper

1. Prerequisites:
   1. `node` (NodeJS) and matching `npm`
   2. `git`
2. Clone `git-remote-gosh` repo and install dependencies with `npm i`
3. Add path with `git-remote-helper` for availability via `$PATH` or symlinked it (e.g. `/usr/local/bin`). Use `which git-remote-gosh` to make sure it's available.

### For existing local repository

To set a remote to an existing local repository:

```sh
git remote add origin gosh::net.ton.dev://my-wallet@0:a6af961f2973bb00fe1d3d6cfee2f2f9c89897719c2887b31ef5ac4fd060638f/my-user-name/my-repo
```

### For a new Gosh repository

To clone repositories you should add 

```sh
git clone gosh::net.ton.dev://my-wallet@0:a6af961f2973bb00fe1d3d6cfee2f2f9c89897719c2887b31ef5ac4fd060638f/my-user-name/my-repo
```

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