@smbcloud / cli / commits / 88b4e52

Revise and unify README docs across crates and packages

keypair34 committed May 3, 2026 at 19:03 UTC 88b4e52c658216796928f5a4ab40866c9d98127f
23 files changed +70 -72
README.MD
+8 -8
@@ -5,7 +5,7 @@
5 <br>smbCloud CLI
6 </h1>
7 <p align="center">
8 - Deploy to the cloud in one command.
8 + Deploy with smbCloud from your terminal.
9 <br />
10 <br />
11 <a href="https://smbcloud.xyz/">Website</a>
@@ -22,19 +22,19 @@
22 <a href="https://www.nuget.org/packages/SmbCloud.Cli"><img alt="NuGet" src="https://img.shields.io/nuget/v/SmbCloud.Cli"></a>
23 <a href="https://github.com/smbcloudXYZ/homebrew-tap"><img alt="Homebrew" src="https://img.shields.io/badge/homebrew-tap-orange?logo=homebrew"></a>
24 <a href="https://pypi.org/project/smbcloud-cli/"><img alt="PyPI" src="https://img.shields.io/pypi/v/smbcloud-cli"></a>
25 - <a href="https://github.com/smbcloudXYZ/smbcloud-cli/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/smbcloudXYZ/smbcloud-cli"></a>
25 + <a href="https://github.com/smbcloudXYZ/smbcloud-cli/blob/main/LICENSE"><img alt="Apache-2.0 License" src="https://img.shields.io/badge/license-Apache%202.0-blue.svg"></a>
26 </p>
27 </p>
28
29 ## About
30
31 -**`smb`** is the command-line interface for [smbCloud](https://smbcloud.xyz/) — the modern cloud deployment platform. We've eliminated the friction of cloud infrastructure so you can focus on what matters: building an incredible product.
31 +**`smb`** is the command-line interface for [smbCloud](https://smbcloud.xyz/).
32
33 -Ship your Rust, Node.js, Ruby, or Swift app with a single, magical command.
33 +Deploy Rust, Node.js, Ruby, or Swift apps from your terminal.
34
35 ## Install
36
37 -We highly recommend using our **pre-built native binaries** for the fastest, frictionless setup.
37 +If you want the quickest setup, use a pre-built native binary.
38
39 ### Homebrew (macOS & Linux)
40
@@ -83,7 +83,7 @@ smb init
83 smb deploy
84 ```
85
86 -That's it. Your app is live.
86 +That gets you from login to first deploy.
87
88 ## Documentation
89
@@ -91,9 +91,9 @@ See the [`docs/`](./docs) directory for guides on authentication, project config
91
92 ## Contributing
93
94 -Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started. All contributions are welcome.
94 +Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started. Contributions are welcome.
95
96 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
96 +For the broader product, see [smbCloud](https://smbcloud.xyz/) and the [deployment docs](https://smbcloud.xyz/posts).
97
98 ## License
99
crates/cli/README.md
+5 -3
@@ -5,7 +5,7 @@
5 <br>smbCloud CLI
6 </h1>
7 <p align="center">
8 - Deploy to the cloud in one command.
8 + Deploy with smbCloud from your terminal.
9 <br />
10 <br />
11 <a href="https://smbcloud.xyz/">Website</a>
@@ -76,7 +76,9 @@ pip uninstall smbcloud-cli
76 smb --help
77 ```
78
79 -## Contribution
79 +## Contributing
80 +
81 +To work on the CLI locally:
82
83 - Set up your Rust tooling.
84 - Clone the repo.
@@ -89,7 +91,7 @@ This repo draws inspiration from [Sugar](https://github.com/metaplex-foundation/
91
92 It also borrows ideas from [the 12 factor CLI app](https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46).
93
92 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
94 +More CLI and deployment guides live in the [smbCloud docs](https://smbcloud.xyz/posts).
95
96 ## License
97
crates/smbcloud-auth-sdk-py/README.md
+2 -2
@@ -1,8 +1,8 @@
1 # smbcloud-auth-sdk-py
2
3 -PyO3 bindings for the smbCloud Auth SDK.
3 +PyO3 bindings for smbCloud Auth.
4
5 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
5 +For higher-level SDK docs, see the [smbCloud developer guides](https://smbcloud.xyz/posts).
6
7 ## License
8
crates/smbcloud-auth-sdk-wasm/README.md
+3 -5
@@ -1,10 +1,8 @@
1 # smbcloud-auth-sdk-wasm
2
3 -Wasm bindings for the smbCloud Auth SDK.
3 +Wasm bindings for smbCloud Auth.
4
5 -This crate is intended to be published as an npm package via `wasm-pack` and
6 -consumed by browser clients that need tenant auth-app signup, sign-in, profile
7 -lookup, and account deletion against the smbCloud Auth service.
5 +This crate is published as an npm package through `wasm-pack` and used by browser clients that need signup, sign-in, profile lookup, logout, and account deletion against smbCloud Auth.
6
7 ## Exports
8
@@ -41,7 +39,7 @@ await signup_with_client(
39 );
40 ```
41
44 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
42 +More browser SDK context is available in the [smbCloud docs](https://smbcloud.xyz/posts).
43
44 ## License
45
crates/smbcloud-auth-sdk/README.md
+2 -2
@@ -1,6 +1,6 @@
1 # smbcloud-auth-sdk
2
3 -Client SDK for [smbCloud Auth](https://smbcloud.xyz/) — lets you authenticate your users against the smbCloud Auth service using your app credentials (`client_id` / `client_secret`).
3 +Client SDK for [smbCloud Auth](https://smbcloud.xyz/). Use your app credentials (`client_id` and `client_secret`) to authenticate users against the smbCloud Auth service.
4
5 ## Usage
6
@@ -28,7 +28,7 @@ let status = login_with_client(Environment::Production, client, email, password)
28 let user = me_with_client(Environment::Production, client, &access_token).await?;
29 ```
30
31 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
31 +See the [smbCloud auth docs](https://smbcloud.xyz/posts) for the wider flow around app credentials and user sessions.
32
33 ## License
34
crates/smbcloud-auth/README.md
+2 -2
@@ -4,9 +4,9 @@ Rust authentication foundation for smbCloud.
4
5 ## About
6
7 -`smbcloud-auth` provides the shared authentication flows used across the smbCloud CLI and SDK ecosystem.
7 +`smbcloud-auth` provides the shared authentication flows used across the smbCloud CLI and SDKs.
8
9 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
9 +For product context, visit [smbCloud](https://smbcloud.xyz/) or read the [developer docs](https://smbcloud.xyz/posts).
10
11 ## License
12
crates/smbcloud-gresiq-sdk/README.md
+3 -3
@@ -1,6 +1,6 @@
1 # smbcloud-gresiq-sdk
2
3 -Rust client for the **smbCloud GresIQ** REST gateway. API-key authenticated app management and model assignment for [Onde Inference](https://ondeinference.com).
3 +Rust client for the smbCloud GresIQ REST gateway. It handles API-key authenticated app management and model assignment for [Onde Inference](https://ondeinference.com).
4
5 ## What is GresIQ?
6
@@ -36,7 +36,7 @@ async fn main() -> anyhow::Result<()> {
36 }
37 ```
38
39 -## Onde Inference — app and model management
39 +## Onde Inference app and model management
40
41 ```rust
42 use smbcloud_gresiq_sdk::{
@@ -68,7 +68,7 @@ rename_app(&Environment::Production, APP_ID, APP_SECRET, &token, &app.id, "Renam
68 | `OndeModel` | Catalog model (id, name, family, format, approx size bytes) |
69 | `Environment` | `Dev` or `Production` |
70
71 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
71 +For the broader product, see [smbCloud](https://smbcloud.xyz/) and related [platform docs](https://smbcloud.xyz/posts).
72
73 ## License
74
crates/smbcloud-gresiq/README.md
+1 -1
@@ -81,7 +81,7 @@ The current bootstrap focuses on connection modeling and operational correctness
81 - metrics, query insights, and tenant-aware usage controls
82 - adapters for smbCloud CLI, Tauri, wasm, npm, and native SDKs
83
84 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
84 +More platform context is on the [smbCloud website](https://smbcloud.xyz/).
85
86 ## License
87
crates/smbcloud-mail/README.md
+1 -1
@@ -6,7 +6,7 @@ Mail routing support crate for smbCloud Mail.
6
7 `smbcloud-mail` provides the shared mail API client layer used by the smbCloud CLI for mail apps, inbox routes, test delivery, and inbound message inspection.
8
9 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
9 +For the wider product story, visit [smbCloud](https://smbcloud.xyz/).
10
11 ## License
12
crates/smbcloud-model/README.md
+1 -1
@@ -2,7 +2,7 @@
2
3 Shared data models for smbCloud CLI services and SDKs.
4
5 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
5 +See the [smbCloud developer docs](https://smbcloud.xyz/posts) for the services that use these models.
6
7 ## License
8
crates/smbcloud-network/README.md
+1 -1
@@ -2,7 +2,7 @@
2
3 Environment and transport helpers for smbCloud clients.
4
5 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
5 +More client and platform context is on [smbcloud.xyz](https://smbcloud.xyz/).
6
7 ## License
8
crates/smbcloud-networking-project/README.md
+1 -1
@@ -2,7 +2,7 @@
2
3 Project-focused networking helpers for the smbCloud CLI.
4
5 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
5 +Project and deployment guides are in the [smbCloud docs](https://smbcloud.xyz/posts).
6
7 ## License
8
crates/smbcloud-networking/README.md
+1 -1
@@ -4,7 +4,7 @@ Low-level HTTP client helpers for smbCloud services.
4
5 This crate takes a few cues from [Designing a Web API client in Rust](https://nullderef.com/blog/web-api-client/).
6
7 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
7 +For higher-level usage, browse the [smbCloud docs](https://smbcloud.xyz/posts).
8
9 ## License
10
crates/smbcloud-s6n/README.md
+1 -1
@@ -2,7 +2,7 @@
2
3 S6n is an S3-compatible object storage crate for smbCloud.
4
5 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
5 +Read more about [smbCloud services](https://smbcloud.xyz/services).
6
7 ## License
8
crates/smbcloud-utils/README.md
+1 -1
@@ -2,7 +2,7 @@
2
3 Shared utility helpers for smbCloud CLI crates.
4
5 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
5 +More about the platform is at [smbCloud](https://smbcloud.xyz/).
6
7 ## License
8
npm/README.md.tmpl
+6 -4
@@ -5,7 +5,7 @@
5 <br>smbCloud CLI
6 </h1>
7 <p align="center">
8 - Deploy to the cloud in one command.
8 + Deploy with smbCloud from your terminal.
9 <br />
10 <br />
11 <a href="https://smbcloud.xyz/">Website</a>
@@ -18,8 +18,8 @@
18
19 ## `${node_pkg}`
20
21 -This is a platform-specific binary package for [`@smbcloud/cli`](https://www.npmjs.com/package/@smbcloud/cli).
22 -It is not intended to be installed directly.
21 +This package only contains one platform binary for [`@smbcloud/cli`](https://www.npmjs.com/package/@smbcloud/cli).
22 +Do not install it directly.
23
24 Install the main package instead:
25
@@ -27,13 +27,15 @@ Install the main package instead:
27 npm install -g @smbcloud/cli
28 ```
29
30 -The main package resolves and downloads the correct platform binary automatically.
30 +The main package picks the right binary for your platform.
31
32 ## Source & Issues
33
34 Source code and issue tracker:
35 [github.com/smbcloudXYZ/smbcloud-cli](https://github.com/smbcloudXYZ/smbcloud-cli)
36
37 +For the main package and docs, start with [smbCloud CLI](https://smbcloud.xyz/posts).
38 +
39 ## License
40
41 [Apache-2.0](https://github.com/smbcloudXYZ/smbcloud-cli/blob/main/LICENSE)
npm/smbcloud-cli/README.md
+8 -8
@@ -5,7 +5,7 @@
5 <br>smbCloud CLI
6 </h1>
7 <p align="center">
8 - Deploy to the cloud in one command.
8 + Deploy with smbCloud from your terminal.
9 <br />
10 <br />
11 <a href="https://smbcloud.xyz/">Website</a>
@@ -26,9 +26,9 @@
26
27 ## About
28
29 -**`smb`** is the command-line interface for [smbCloud](https://smbcloud.xyz/) — the modern cloud deployment platform. We've eliminated the friction of cloud infrastructure so you can focus on what matters: building an incredible product.
29 +**`smb`** is the command-line interface for [smbCloud](https://smbcloud.xyz/).
30
31 -Ship your Rust, Node.js, Ruby, or Swift app with a single, magical command.
31 +Install it with npm, then run the native `smb` binary for your platform.
32
33 ## Install
34
@@ -36,7 +36,7 @@ Ship your Rust, Node.js, Ruby, or Swift app with a single, magical command.
36 npm install -g @smbcloud/cli
37 ```
38
39 -This package automatically downloads and installs the correct pre-built native binary for your platform.
39 +This package downloads the right pre-built native binary for your platform.
40
41 ## Quick Start
42
@@ -46,7 +46,7 @@ smb init
46 smb deploy
47 ```
48
49 -That's it. Your app is live.
49 +That gets you from login to first deploy.
50
51 ## Other Installation Methods
52
@@ -97,11 +97,11 @@ This package ships pre-built native binaries for:
97
98 ## Source & Issues
99
100 -This is a native binary distributed via npm. The source code lives at
100 +This package ships the native `smb` binary through npm.
101 +Source code and issue tracker:
102 [github.com/smbcloudXYZ/smbcloud-cli](https://github.com/smbcloudXYZ/smbcloud-cli).
102 -Please report bugs and feature requests there.
103
104 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
104 +You can find the main install and deploy guides in the [smbCloud CLI docs](https://smbcloud.xyz/posts).
105
106 ## License
107
nuget/smbcloud-cli/README.md
+2 -2
@@ -1,6 +1,6 @@
1 # smbCloud CLI for .NET
2
3 -`smb` is the official command-line interface for [smbCloud](https://smbcloud.xyz/).
3 +`smb` is the command-line interface for [smbCloud](https://smbcloud.xyz/).
4
5 ## Install
6
@@ -43,7 +43,7 @@ This .NET tool bundles native `smb` binaries for:
43 - Documentation: <https://smbcloud.xyz/posts>
44 - Issues: <https://github.com/smbcloudXYZ/smbcloud-cli/issues>
45
46 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
46 +More about the product is on the [smbCloud website](https://smbcloud.xyz/).
47
48 ## License
49
pypi/README.md
+8 -8
@@ -5,7 +5,7 @@
5 <br>smbCloud CLI
6 </h1>
7 <p align="center">
8 - Deploy to the cloud in one command.
8 + Deploy with smbCloud from your terminal.
9 <br />
10 <br />
11 <a href="https://smbcloud.xyz/">Website</a>
@@ -28,9 +28,9 @@
28
29 ## About
30
31 -**`smb`** is the command-line interface for [smbCloud](https://smbcloud.xyz/) — the modern cloud deployment platform. We've eliminated the friction of cloud infrastructure so you can focus on what matters: building an incredible product.
31 +**`smb`** is the command-line interface for [smbCloud](https://smbcloud.xyz/).
32
33 -Ship your Rust, Node.js, Ruby, or Swift app with a single, magical command.
33 +Install it with `pip`, then run the native `smb` binary for your platform.
34
35 ## Install
36
@@ -38,7 +38,7 @@ Ship your Rust, Node.js, Ruby, or Swift app with a single, magical command.
38 pip install smbcloud-cli
39 ```
40
41 -This package installs the native `smb` executable for your platform directly — no Node.js, no Docker, no runtime dependencies.
41 +This package installs the native `smb` executable for your platform. You do not need Node.js or Docker.
42
43 ## Quick Start
44
@@ -48,7 +48,7 @@ smb init
48 smb deploy
49 ```
50
51 -That's it. Your app is live.
51 +That gets you from login to first deploy.
52
53 ## Other Installation Methods
54
@@ -101,11 +101,11 @@ This package ships pre-built native binaries for:
101
102 ## Source & Issues
103
104 -This is a native binary distributed via PyPI. The source code lives at
104 +This package ships the native `smb` binary through PyPI.
105 +Source code and issue tracker:
106 [github.com/smbcloudXYZ/smbcloud-cli](https://github.com/smbcloudXYZ/smbcloud-cli).
106 -Please report bugs and feature requests there.
107
108 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
108 +See the [smbCloud documentation](https://smbcloud.xyz/posts) for setup and deployment guides.
109
110 ## License
111
sdk/gems/auth/README.md
+3 -3
@@ -1,6 +1,6 @@
1 # smbcloud-auth Gem
2
3 -Ruby bindings for the smbCloud Auth SDK.
3 +Ruby bindings for smbCloud Auth.
4
5 ## Install
6
@@ -42,7 +42,7 @@ me = client.me(access_token: login[:access_token])
42 - `logout(access_token:)`
43 - `remove(access_token:)`
44
45 -For simple scripting, module-level convenience wrappers are also available:
45 +Module-level helpers are also available:
46
47 - `SmbCloud::Auth.signup_with_client(...)`
48 - `SmbCloud::Auth.login_with_client(...)`
@@ -50,7 +50,7 @@ For simple scripting, module-level convenience wrappers are also available:
50 - `SmbCloud::Auth.logout_with_client(...)`
51 - `SmbCloud::Auth.remove_with_client(...)`
52
53 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
53 +More auth and SDK notes are in the [smbCloud docs](https://smbcloud.xyz/posts).
54
55 ## License
56
sdk/gems/model/README.md
+3 -3
@@ -1,10 +1,10 @@
1 # smbcloud-model Gem
2
3 -Ruby Gem version of `smbcloud-model`.
3 +Ruby package for `smbcloud-model`.
4
5 -[Docs](./docs/gems.md).
5 +See [docs/gems.md](./docs/gems.md).
6
7 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
7 +For the wider SDK context, visit the [smbCloud developer docs](https://smbcloud.xyz/posts).
8
9 ## License
10
sdk/npm/smbcloud-auth/README.md
+4 -7
@@ -5,7 +5,7 @@
5 <br>smbCloud SDK Auth
6 </h1>
7 <p align="center">
8 - Browser authentication SDK for smbCloud, built from Rust and WebAssembly.
8 + Browser auth SDK for smbCloud.
9 <br />
10 <a href="README.md#about">About</a>
11 ·
@@ -19,9 +19,7 @@
19
20 ## About
21
22 -`@smbcloud/sdk-auth` is the browser SDK for smbCloud Auth. It wraps the shared Rust
23 -Auth crate through WebAssembly so browser apps can use the same auth
24 -contract as desktop and mobile clients.
22 +`@smbcloud/sdk-auth` is the browser SDK for smbCloud Auth. It wraps the shared Rust auth crate through WebAssembly so browser apps can use the same auth API as other smbCloud clients.
23
24 Current exported browser APIs include:
25
@@ -67,10 +65,9 @@ npm run prepare:package
65 npm run pack:dry-run
66 ```
67
70 -This builds the wasm crate, stages the generated artifacts into the npm package
71 -folder, and lets you verify the publish payload before release.
68 +This builds the wasm crate, stages the generated artifacts into the npm package folder, and lets you check the publish payload before release.
69
73 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
70 +More browser and platform docs live in the [smbCloud developer docs](https://smbcloud.xyz/posts).
71
72 ## License
73
sdk/python/README.md
+3 -4
@@ -1,11 +1,10 @@
1 # smbCloud SDK Auth
2
3 -Python authentication SDK for smbCloud, built from Rust.
3 +Python auth SDK for smbCloud.
4
5 ## About
6
7 -`smbcloud-sdk-auth` wraps the shared Rust Auth crate through PyO3 and maturin so
8 -Python apps can use the same tenant auth contract as the browser SDK.
7 +`smbcloud-sdk-auth` wraps the shared Rust auth crate through PyO3 so Python apps can use the same auth API as the browser SDK.
8
9 Current exported Python APIs include:
10
@@ -47,7 +46,7 @@ From `sdk/python`:
46 maturin build
47 ```
48
50 -> Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
49 +For the wider platform and docs, see [smbCloud](https://smbcloud.xyz/) and the [developer guides](https://smbcloud.xyz/posts).
50
51 ## License
52