# ssb-cli

**Repository Path**: mirrors_regular/ssb-cli

## Basic Information

- **Project Name**: ssb-cli
- **Description**:   Friendly command-line interface for Secure Scuttlebutt.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

> This fork uses ssb-zero-conf-client and is specific to tre/Bay of Plenty in that it looks for a .trerc file in cwd or above to get `caps.shs`. It reads `.tre/secret` and waits for an ssb-server on the local network (with matching caps.shs) to broadcast it's address (happens every second).

The following is Christian's original README.md

# SSB-CLI

**Friendly command-line interface for Secure Scuttlebutt.**

This is a small experimental client that connects to an existing SSB service
and runs commands over [MuxRPC][muxrpc]. All usage information is generated
dynamically from the [MuxRPC-Usage][muxrpc-usage] format and passed to the
command-line interface via [Yargs][yargs].

**Status:** Alpha. Please reach out to share feedback and suggestions!

## Usage

Run commands from your terminal without having to open a client.

```console
$ ssb whoami
{
  "id": "@+oaWWDs8g73EZFUMfW37R/ULtFEjwKN/DczvdYihjbU=.ed25519"
}
```

If you make a mistake or append `--help` you'll get helpful usage information.

```console
$ ssb createHistoryStream
ssb createHistoryStream

Output messages from a feed in order (source)

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
  --id       A ssb feed identity (FeedId)                    [string] [required]
  --keys     Include keys                                              [boolean]
  --limit    Max number of messages to output                           [number]
  --seq      Sequence number to stream from (SequenceNumber)            [number]
  --values   Include values                                            [boolean]

Missing required argument: id
```

Pass `{ foo: true }` or `{ foo: false }` with `--foo` or `--no-foo`.

```console
$ ssb publish --type contact --contact @abc.xyz --following
{
  "key": "...",
  "value": {
    "...": "...",
    "content": {
      "type": "contact",
      "contact": "@abc.xyz",
      "following": true
    }
  }
}
```

## Installation

With [npm](https://npmjs.org/):

```shell
npm -g install ssb-cli@latest
```

With [yarn](https://yarnpkg.com/en/):

```shell
yarn global add ssb-cli@latest
```

You'll need an SSB service running for ssb-cli to connect to. Try one of these:

- [Oasis](https://github.com/fraction/oasis)
- [Patchbay](https://github.com/ssbc/patchbay)
- [Patchwork](https://github.com/ssbc/patchwork)
- [SSB-Server](https://github.com/ssbc/ssb-server)

## Resources

- [Help](https://github.com/fraction/ssb-cli/issues/new)
- [Source Code](https://github.com/fraction/ssb-cli.git)

## See Also

- [MuxRPCLI](https://github.com/ssbc/muxrpcli)
- [SSB-Client-CLI](https://github.com/qypea/ssb-client-cli)

## License

AGPL-3.0

[muxrpc]: https://github.com/ssbc/muxrpc
[muxrpc-usage]: https://github.com/ssbc/muxrpc-usage
[yargs]: https://github.com/yargs/yargs