49 releases (15 breaking)
0.17.0 | Jan 30, 2024 |
---|---|
0.16.0 | Nov 21, 2023 |
0.15.4 | Nov 1, 2023 |
0.13.2 | Jul 21, 2023 |
0.5.0 | Nov 30, 2022 |
#327 in Authentication
85 downloads per month
415KB
9K
SLoC
Noosphere CLI
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
# 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`
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.
# 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>
Dependencies
~4–48MB
~813K SLoC