#cli #sync #noosphere #p2p #ucan

bin+lib noosphere-cli

Reference client and pedagogical tool to demonstrate the principles of the Noosphere protocol

43 releases (13 breaking)

new 0.15.0 Sep 19, 2023
0.13.2 Jul 21, 2023
0.8.0 Mar 29, 2023
0.6.0 Dec 15, 2022
0.5.0 Nov 30, 2022

#113 in Authentication

Download history 31/week @ 2023-06-03 54/week @ 2023-06-10 51/week @ 2023-06-17 58/week @ 2023-06-24 59/week @ 2023-07-01 19/week @ 2023-07-08 44/week @ 2023-07-15 35/week @ 2023-07-22 19/week @ 2023-07-29 87/week @ 2023-08-05 42/week @ 2023-08-12 60/week @ 2023-08-26 11/week @ 2023-09-02 82/week @ 2023-09-09 30/week @ 2023-09-16

183 downloads per month

MIT/Apache

395KB
8K SLoC

API Stability: Alpha

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

~0–53MB
~874K SLoC