From 10164edf9f2586f204e5514702bfd273e8a88c99 Mon Sep 17 00:00:00 2001 From: jazkamer Date: Thu, 23 Oct 2025 11:26:58 +0300 Subject: [PATCH 1/3] chore: Update docs --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2b3fd40..0dbcaf6 100644 --- a/README.md +++ b/README.md @@ -24,13 +24,13 @@ admin and user-facing APIs, reusing the official `pubky` SDK (`0.6.0-rc.6`) and cargo build # Run the CLI (examples assume the admin API listens on http://127.0.0.1:6288) -PUBKY_ADMIN_PASSWORD=admin cargo run -- admin info +PUBKY_ADMIN_PASSWORD=admin pubky-cli admin info # Create a recovery file (writes ./alice.recovery and prints the pubkey) -cargo run -- tools generate-recovery ./alice.recovery --passphrase pass +pubky-cli tools generate-recovery ./alice.recovery --passphrase pass # Signup a user (passphrase entered interactively unless the env var below is set) -PUBKY_CLI_RECOVERY_PASSPHRASE=pass cargo run -- user signup ./alice.recovery --testnet +PUBKY_CLI_RECOVERY_PASSPHRASE=pass pubky-cli user signup --singup-code ./alice.recovery --testnet ``` ### Common Flows @@ -41,23 +41,23 @@ Once your homeserver is running locally you can drive full workflows directly fr ```bash # 1) Create a recovery file and note the printed public key -cargo run -- tools generate-recovery ./alice.recovery --passphrase pass +pubky-cli tools generate-recovery ./alice.recovery --passphrase pass # 2) Sign up; replace with your server's public key PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ - cargo run -- user signup ./alice.recovery --testnet + pubky-cli user signup ./alice.recovery --testnet # 3) Sign in to establish a session PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ - cargo run -- user signin ./alice.recovery --testnet + pubky-cli user signin ./alice.recovery --testnet # 4) Inspect the active session PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ - cargo run -- user session ./alice.recovery --testnet + pubky-cli user session ./alice.recovery --testnet # 5) Sign out when finished PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ - cargo run -- user signout ./alice.recovery --testnet + pubky-cli user signout ./alice.recovery --testnet ``` #### User Publish/Get/Delete Data @@ -65,15 +65,15 @@ PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ ```bash # 1) Publish data from file PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ - cargo run -- user publish "/pub/my-cool-app/hello.txt" test.txt ./alice.recovery --testnet + pubky-cli user publish "/pub/my-cool-app/hello.txt" test.txt ./alice.recovery --testnet # 2) Get data by path PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ - cargo run -- user get /pub/my-cool-app/hello.txt ./alice.recovery + pubky-cli user get /pub/my-cool-app/hello.txt ./alice.recovery # 3) Delete data by path PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ - cargo run -- user delete "/pub/my-cool-app/hello.txt" ./alice.recovery + pubky-cli user delete "/pub/my-cool-app/hello.txt" ./alice.recovery ``` @@ -81,10 +81,10 @@ PUBKY_CLI_RECOVERY_PASSPHRASE=pass \ ```bash # Use the user's public key printed during signup -PUBKY_ADMIN_PASSWORD=admin cargo run -- admin user disable +PUBKY_ADMIN_PASSWORD=admin pubky-cli admin user disable # Re-enable the same user -PUBKY_ADMIN_PASSWORD=admin cargo run -- admin user enable +PUBKY_ADMIN_PASSWORD=admin pubky-cli admin user enable ``` The examples above assume defaults (`http://127.0.0.1:6288` for the admin API and `--testnet` From b41483b4df2e1828159578cd5c20ad7e999de24a Mon Sep 17 00:00:00 2001 From: jazkamer Date: Thu, 23 Oct 2025 11:55:06 +0300 Subject: [PATCH 2/3] chore: Update docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0dbcaf6..9f0aa1d 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ admin and user-facing APIs, reusing the official `pubky` SDK (`0.6.0-rc.6`) and ```bash # Clone and build -cargo build +cargo install --path . # Run the CLI (examples assume the admin API listens on http://127.0.0.1:6288) PUBKY_ADMIN_PASSWORD=admin pubky-cli admin info From ceca90ac281e8399b4f57f36da9afb365587ceed Mon Sep 17 00:00:00 2001 From: jazkamer Date: Thu, 23 Oct 2025 12:06:45 +0300 Subject: [PATCH 3/3] chore: Update docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f0aa1d..a0cfd63 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ admin and user-facing APIs, reusing the official `pubky` SDK (`0.6.0-rc.6`) and ## Quick Start ```bash -# Clone and build +# Clone and install cargo install --path . # Run the CLI (examples assume the admin API listens on http://127.0.0.1:6288)