@smbcloud / cli
Code Commits Issues Pulls Cloud Agent CI/CD
feature/ci-docs
claude/smbcloud-github-app-k9641p development feature/apps feature/build-release feature/ci-docs feature/ci-ruby-gems feature/cicd feature/completion feature/dist-nuget feature/fix-ci-sdk-pypi-rubygem feature/fix-clippy-on-stable-channel feature/fix-deployment-script feature/github-email feature/gresiq-v1 feature/project-new-structure feature/rsync-deploy feature/ruby-runner feature/sdk-npm feature/sdk-workflows feature/smbcloud-cli-release-npm feature/smbcloud-deploy feature/wasm main release/v0.7.4
md 121 lines 3.33 KB
Rendered Raw
1 <!-- LOGO -->
2 <h1>
3 <p align="center">
4 <img src="https://avatars.githubusercontent.com/u/89791739?s=200&v=4" alt="smbCloud Logo" width="128">
5 <br>smbCloud CLI
6 </h1>
7 <p align="center">
8 Deploy with smbCloud from your terminal.
9 <br />
10 <br />
11 <a href="https://smbcloud.xyz/">Website</a>
12 ·
13 <a href="./docs">Documentation</a>
14 ·
15 <a href="CONTRIBUTING.md">Contributing</a>
16 ·
17 <a href="https://github.com/smbcloudXYZ/smbcloud-cli/releases">Releases</a>
18 </p>
19 <p align="center">
20 <a href="https://crates.io/crates/smbcloud-cli"><img alt="Crates.io" src="https://img.shields.io/crates/v/smbcloud-cli"></a>
21 <a href="https://www.npmjs.com/package/@smbcloud/cli"><img alt="npm" src="https://img.shields.io/npm/v/@smbcloud/cli"></a>
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="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/).
32
33 Deploy Rust, Node.js, Ruby, or Swift apps from your terminal.
34
35 ## Install
36
37 If you want the quickest setup, use a pre-built native binary.
38
39 ### Homebrew (macOS & Linux)
40
41 ```sh
42 brew tap smbcloudXYZ/tap
43 brew install cli
44 ```
45
46 ### npm
47
48 ```sh
49 npm install -g @smbcloud/cli
50 ```
51
52 ### .NET tool
53
54 ```sh
55 dotnet tool install --global SmbCloud.Cli
56 ```
57
58 ### pip
59
60 ```sh
61 pip install smbcloud-cli
62 ```
63
64 ### Shell (macOS / Linux)
65
66 ```sh
67 curl -fsSL https://raw.githubusercontent.com/smbcloudXYZ/smbcloud-cli/main/install-unix.sh | sh
68 ```
69
70 ### PowerShell (Windows)
71
72 ```powershell
73 irm https://raw.githubusercontent.com/smbcloudXYZ/smbcloud-cli/main/install-windows.sh | iex
74 ```
75
76 Or grab a pre-built binary from the [Releases](https://github.com/smbcloudXYZ/smbcloud-cli/releases) page.
77
78 ## Quick Start
79
80 ```sh
81 smb login
82 smb init
83 smb deploy
84 ```
85
86 That gets you from login to first deploy.
87
88 ## CI / non-interactive mode
89
90 Pass `--ci` (or set `SMB_CI=1`, or run under any provider that sets `CI`) to
91 disable interactive prompts. Confirmations take their default; anything that
92 truly needs input fails fast with a clear message instead of hanging on a
93 missing TTY.
94
95 ```sh
96 smb --ci deploy
97 ```
98
99 For example, the [AircraftsHub](https://aircraftshub.5mb.app) monorepo deploys
100 its Next.js web app with a single non-interactive command — its
101 `.smb/config.toml` pins the project, source, and runtime, so `smb --ci deploy`
102 needs no prompts. See [`docs/ci.md`](./docs/ci.md) for token setup and the full
103 behavior reference.
104
105 ## Documentation
106
107 See the [`docs/`](./docs) directory for guides on authentication, project configuration, and deployment workflows.
108
109 ## Contributing
110
111 Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started. Contributions are welcome.
112
113 For the broader product, see [smbCloud](https://smbcloud.xyz/) and the [deployment docs](https://smbcloud.xyz/posts).
114
115 ## License
116
117 [Apache-2.0](LICENSE)
118
119 ## Copyright
120
121 © 2026 [smbCloud](https://smbcloud.xyz) (Splitfire AB).