https://github.com/regular/tre-cli-about
https://github.com/regular/tre-cli-about
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/regular/tre-cli-about
- Owner: regular
- Created: 2020-11-19T16:08:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-19T16:53:45.000Z (over 5 years ago)
- Last Synced: 2024-04-24T03:23:25.735Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tre-cli-about
Publishes about messages with name, description and image properties to an ssb network.
Uploads image files as blobs and supports reading images from stdin.
```
USAGE
tre-cli-about TARGET [--name NAME] [--description DESC] [--image FILE|-] [--dryRun] [--config CONFIG] [--help]
DESCRIPTION
tre-cli-about posts an about message, will upload blobs when needed
TARGET about target (might be feed id, message id or anything else)
--name NAME sets about.name
--description DESC sets about.description
--image FILE uploads FILE as a blob and sets about.image to resulting blob id. If FILE is '-' (minus), STDIN is read.
--dryRun do not publish any messages and show diagnostic output
--config CONFIG path to JSON file with caps.shs, defaults to .trerc (see FILES)
--help show help
FILES
If --config CONFIG is not given, tre-cli-about looks for a file named .trerc in the current directory or above. (and other locations, see rc on npm for details)
That JSON formatted file must have a property called csps.shs (the network key). The network key is used to discover a ssb server on the local network that shares its manifest with us. This usually only is the case, if it uses the same ssb id (e.g. tre server started from the same directory), or our ssb id is authorized by the server to call manifest() (e.g. bay-of-pleny started with --authorize or ssb-server started with our public key in config.master)
Auto-discovery ony works if the server uses ssb-lan to broadcasts its address. Bay-of-plenty and tre server do this.
EXAMPLE
tre-cli-about @foobar... --image avatar.svg --dryRun
```
---
License: MIT Copyright 2020 Jan Bölsche (https://regular.codes/)