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. All usage information is generated dynamically from the MuxRPC-Usage format and passed to the command-line interface via Yargs.
Status: Alpha. Please reach out to share feedback and suggestions!
Usage
Run commands from your terminal without having to open a client.
$ ssb whoami
{
"id": "@+oaWWDs8g73EZFUMfW37R/ULtFEjwKN/DczvdYihjbU=.ed25519"
}If you make a mistake or append --help you'll get helpful usage information.
$ 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: idPass { foo: true } or { foo: false } with --foo or --no-foo.
$ ssb publish --type contact --contact @abc.xyz --following
{
"key": "...",
"value": {
"...": "...",
"content": {
"type": "contact",
"contact": "@abc.xyz",
"following": true
}
}
}Installation
With npm:
npm -g install ssb-cli@latestWith yarn:
yarn global add ssb-cli@latestYou'll need an SSB service running for ssb-cli to connect to. Try one of these:
Resources
See Also
License
AGPL-3.0
