From d0b113715734b4684acc1e9f462ffd2e73870c19 Mon Sep 17 00:00:00 2001 From: Justin Abrahms Date: Tue, 27 Jun 2023 11:28:28 -0700 Subject: [PATCH 1/4] Initial docs on how to use the CLI. Fixes #445 --- rust/noosphere-cli/README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/rust/noosphere-cli/README.md b/rust/noosphere-cli/README.md index 0c4a0b00b..d9963a1ad 100644 --- a/rust/noosphere-cli/README.md +++ b/rust/noosphere-cli/README.md @@ -5,3 +5,39 @@ 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 + +```sh +# Create your 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 + +# join a gateway +orb config set gateway-url + +# sync your changes with the upstream gateway +orb sync + +# sync data from a different sphere. Note, you'll need to +# `orb auth add ` from that other sphere. +orb sphere join --local-key `whoami` + +# then follow the onscreen instructions. + +``` From 1d0494ccee94a18eeaadcd38e991754a12beaf3e Mon Sep 17 00:00:00 2001 From: Justin Abrahms Date: Tue, 27 Jun 2023 11:33:16 -0700 Subject: [PATCH 2/4] Document the gateway part as well. --- rust/noosphere-cli/README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/rust/noosphere-cli/README.md b/rust/noosphere-cli/README.md index d9963a1ad..e2d703928 100644 --- a/rust/noosphere-cli/README.md +++ b/rust/noosphere-cli/README.md @@ -8,9 +8,9 @@ no-code, low-complexity tool to synchronize content through the Noosphere. ## Usage - +### User perspective ```sh -# Create your identity +# Create an identity orb key create `whoami` # make a directory for your sphere. @@ -28,7 +28,7 @@ orb status # persist changes to the sphere orb save -# join a gateway +# join a gateway, after you've set this identity as the counterpart orb config set gateway-url # sync your changes with the upstream gateway @@ -39,5 +39,22 @@ orb sync orb sphere join --local-key `whoami` # 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 ``` From dfab2e2b5c146defae24c2f209ea6ea21046142c Mon Sep 17 00:00:00 2001 From: Justin Abrahms Date: Tue, 27 Jun 2023 15:06:13 -0700 Subject: [PATCH 3/4] Update rust/noosphere-cli/README.md --- rust/noosphere-cli/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/rust/noosphere-cli/README.md b/rust/noosphere-cli/README.md index e2d703928..dcd8b3fb5 100644 --- a/rust/noosphere-cli/README.md +++ b/rust/noosphere-cli/README.md @@ -37,6 +37,7 @@ orb sync # sync data from a different sphere. Note, you'll need to # `orb auth add ` from that other sphere. orb sphere join --local-key `whoami` +orb sync # pull in their changes # then follow the onscreen instructions. ``` From 9003efbd3ea4efa26b37733e84e4bedbacce657d Mon Sep 17 00:00:00 2001 From: Justin Abrahms Date: Tue, 27 Jun 2023 15:07:00 -0700 Subject: [PATCH 4/4] Update rust/noosphere-cli/README.md --- rust/noosphere-cli/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rust/noosphere-cli/README.md b/rust/noosphere-cli/README.md index dcd8b3fb5..d3b74ed3a 100644 --- a/rust/noosphere-cli/README.md +++ b/rust/noosphere-cli/README.md @@ -28,7 +28,7 @@ orb status # persist changes to the sphere orb save -# join a gateway, after you've set this identity as the counterpart +# link your sphere to a gateway by setting this identity as the counterpart orb config set gateway-url # sync your changes with the upstream gateway