CLI
smb is the smbCloud command-line tool. You use it to log in and to manage and
deploy your smbCloud resources — projects, tenants, Mail, Auth, simulators, and
ControlKit runners — from the terminal, a script, or an MCP-connected AI agent.
Usage: smb [OPTIONS] [COMMAND]
Commands:
deploy Deploy project. This is smb main command. Requires an smbCloud account.
init Initialize project. Requires an smbCloud account.
login Login to your account.
logout Logout from your account.
me Your account info.
migrate Migrate local .smb/config.toml deploy fields to the smbCloud server.
account Manage your account.
project Manage your projects.
tenant Manage your tenants.
mail Manage smbCloud Mail.
auth Manage smbCloud Auth apps.
help Print this message or the help of the given subcommand(s)
Options:
-e, --environment <ENVIRONMENT> Environment: dev, production [default: production]
-l, --log-level <LOG_LEVEL> Log level: trace, debug, info, warn, error, off
--ci Non-interactive mode for CI/automation
--tui Full-screen TUI mode for the read commands
--mcp Run as an MCP server over stdio
-h, --help Print help
-V, --version Print versionInstall
Pick the channel that fits your setup — each one installs the same smb binary.
| Channel | Best for | Guide |
|---|---|---|
| Native (Cargo) | Rust users, building from source | Native |
| Homebrew | macOS / Linux, pre-built binary | Homebrew |
| npm | JS toolchains (npm, pnpm, bun, yarn) | npm |
| PyPI | Python toolchains (uv, pip) | PyPI |
After installing, check it worked:
smb --versionYou can also download a binary for any release directly from the GitHub releases page .
Guides
| Guide | What it covers |
|---|---|
| Interfaces | The three ways smb runs — headless, --tui, and --mcp — and when to use each. |
| MCP Server | Connect Claude Desktop, Claude Code, Cursor, or any MCP client to smb --mcp; the full tool reference. |
| ControlKit runners | Build native iOS, tvOS, visionOS, watchOS, and macOS runners and expose them through the MCP servers. |
| CI | Run smb non-interactively with --ci and deploy from GitHub Actions. |
The install, guide, and contributing pages in this section are synced from the smbcloud-cli repository. Edit them there.
Last updated on