{"id":26517187,"url":"https://github.com/fraction/ssb-cli","last_synced_at":"2025-03-21T08:18:59.839Z","repository":{"id":44018854,"uuid":"223233547","full_name":"fraction/ssb-cli","owner":"fraction","description":"  Friendly command-line interface for Secure Scuttlebutt.","archived":false,"fork":false,"pushed_at":"2023-01-05T05:40:44.000Z","size":280,"stargazers_count":26,"open_issues_count":11,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T14:08:15.180Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fraction.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-21T18:00:17.000Z","updated_at":"2022-08-04T08:21:10.000Z","dependencies_parsed_at":"2023-02-03T14:00:21.643Z","dependency_job_id":null,"html_url":"https://github.com/fraction/ssb-cli","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraction%2Fssb-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraction%2Fssb-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraction%2Fssb-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraction%2Fssb-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fraction","download_url":"https://codeload.github.com/fraction/ssb-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244759953,"owners_count":20505716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-21T08:18:59.304Z","updated_at":"2025-03-21T08:18:59.827Z","avatar_url":"https://github.com/fraction.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SSB-CLI\n\n**Friendly command-line interface for Secure Scuttlebutt.**\n\nThis is a small experimental client that connects to an existing SSB service\nand runs commands over [MuxRPC][muxrpc]. All usage information is generated\ndynamically from the [MuxRPC-Usage][muxrpc-usage] format and passed to the\ncommand-line interface via [Yargs][yargs].\n\n**Status:** Alpha. Please reach out to share feedback and suggestions!\n\n## Usage\n\nRun commands from your terminal without having to open a client.\n\n```console\n$ ssb whoami\n{\n  \"id\": \"@+oaWWDs8g73EZFUMfW37R/ULtFEjwKN/DczvdYihjbU=.ed25519\"\n}\n```\n\nIf you make a mistake or append `--help` you'll get helpful usage information.\n\n```console\n$ ssb createHistoryStream\nssb createHistoryStream\n\nOutput messages from a feed in order (source)\n\nOptions:\n  --help     Show help                                                 [boolean]\n  --version  Show version number                                       [boolean]\n  --id       A ssb feed identity (FeedId)                    [string] [required]\n  --keys     Include keys                                              [boolean]\n  --limit    Max number of messages to output                           [number]\n  --seq      Sequence number to stream from (SequenceNumber)            [number]\n  --values   Include values                                            [boolean]\n\nMissing required argument: id\n```\n\nPass `{ foo: true }` or `{ foo: false }` with `--foo` or `--no-foo`.\n\n```console\n$ ssb publish --type contact --contact @abc.xyz --following\n{\n  \"key\": \"...\",\n  \"value\": {\n    \"...\": \"...\",\n    \"content\": {\n      \"type\": \"contact\",\n      \"contact\": \"@abc.xyz\",\n      \"following\": true\n    }\n  }\n}\n```\n\n## Installation\n\nWith [npm](https://npmjs.org/):\n\n```shell\nnpm -g install ssb-cli@latest\n```\n\nWith [yarn](https://yarnpkg.com/en/):\n\n```shell\nyarn global add ssb-cli@latest\n```\n\nYou'll need an SSB service running for ssb-cli to connect to. Try one of these:\n\n- [Oasis](https://github.com/fraction/oasis)\n- [Patchbay](https://github.com/ssbc/patchbay)\n- [Patchwork](https://github.com/ssbc/patchwork)\n- [SSB-Server](https://github.com/ssbc/ssb-server)\n\n## Resources\n\n- [Help](https://github.com/fraction/ssb-cli/issues/new)\n- [Source Code](https://github.com/fraction/ssb-cli.git)\n\n## See Also\n\n- [MuxRPCLI](https://github.com/ssbc/muxrpcli)\n- [SSB-Client-CLI](https://github.com/qypea/ssb-client-cli)\n\n## License\n\nAGPL-3.0\n\n[muxrpc]: https://github.com/ssbc/muxrpc\n[muxrpc-usage]: https://github.com/ssbc/muxrpc-usage\n[yargs]: https://github.com/yargs/yargs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffraction%2Fssb-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffraction%2Fssb-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffraction%2Fssb-cli/lists"}