Skip to content
This repository has been archived by the owner on Sep 21, 2024. It is now read-only.

chore: Documentation on how the CLI works #448

Merged
merged 4 commits into from
Jun 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions rust/noosphere-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,57 @@
The Noosphere CLI is a reference client and pedagogical tool to demonstrate
the principles of the Noosphere protocol and give interested users a
no-code, low-complexity tool to synchronize content through the Noosphere.


## Usage
### User perspective
```sh
# Create an identity
orb key create `whoami`

# make a directory for your sphere.
mkdir my-sphere
cd my-sphere

# Generate your personal sphere.
orb sphere create --owner-key `whoami`

# ..now make edits ..

# see the status of files in your directory
orb status

# persist changes to the sphere
orb save

# link your sphere to a gateway by setting this identity as the counterpart
orb config set gateway-url <gatewayurl>

# sync your changes with the upstream gateway
orb sync

# sync data from a different sphere. Note, you'll need to
# `orb auth add <did>` from that other sphere.
orb sphere join <their DID> --local-key `whoami`
justinabrahms marked this conversation as resolved.
Show resolved Hide resolved
orb sync # pull in their changes

# then follow the onscreen instructions.
```

### Gateway perspective
Note: The name `mygateway` below isn't special. Just a chosen name.

```sh
# Create an identity
orb key create mygateway

# make a directory for your sphere.
mkdir my-sphere
cd my-sphere

# Generate your personal sphere.
orb sphere create --owner-key mygateway

# Pair this with a user identity
orb config set counterpart <DID from the user>
```