Command guide

Every SMART command, explained.

Use this reference to understand what a command changes, then copy the exact form you need.

Command reference

Scaffold examples use --dry-run to produce a reviewable plan without writing. Replace it with --yes only after reviewing the planned files.

Environment check

Validate the embedded scaffold catalog and every registered template before generating a project.

smart doctor
Scaffold catalog

List the available data-driven scaffold recipes and their identifiers.

smart catalog list

Show one recipe’s purpose, required roles, parameters, and version.

smart catalog describe service/edocument
Projects

Plan a new rc8 SOKit project with explicit identity, package, and repository topology settings.

smart project init ./platform --id platform --name Platform --group com.example --base-package com.example.platform --topology monorepo --dry-run

Inspect an existing repository and plan SMART settings without replacing its application files.

smart project adopt . --dry-run

Read a project’s detected topology, settings, components, and supporting evidence without changing it.

smart project inspect .

Check project settings and detected files, then report actionable validation diagnostics.

smart project validate .
UI applications

Plan a SOKit UI 1.1.4 application inside the selected project and placement.

smart app add ui portal --project . --dry-run
Services

Plan an rc8 e-document service with its data and document module boundaries.

smart service add edocument documents --project . --dry-run

Plan the project’s singleton rc8 reference service and persistence modules.

smart service add reference references --project . --dry-run

Plan the project’s singleton rc8 bucket service with its selected storage driver.

smart service add bucket files --project . --dry-run

Plan the project’s singleton rc8 notifier service and optional delivery drivers.

smart service add notifier notifications --project . --dry-run
Bucket scopes

Plan a validated scope for an existing bucket service, including storage, limits, media types, and roles.

smart bucket scope add attachments --storage primary --project . --dry-run
Authentication

Open the secure browser sign-in flow and save the resulting SMART credentials.

smart auth login

Print a local QR, verification URL, and short code, then wait while you sign in from any browser.

smart auth login --device

Refresh the current SMART session and immediately load its effective roles.

smart auth refresh

Show whether SMART is signed in and which identity it is using.

smart auth status

Sign out of SMART and remove its locally stored credentials.

smart auth logout

Device sign-in, from terminal to SMART

Genuine local footage of one completed device-authorization flow using the compiled native SMART CLI. The code and credential forms are shown as distinct steps, but their entry is omitted; no password, token, or reusable credential appears.

Read the transcript
  1. Run smart auth login --device; SMART prints a local terminal QR code, verification URL, and short one-time code.
  2. The real Keycloak Device Login form shows where the one-time code is entered; the recorded field remains empty.
  3. After the code is submitted, Keycloak asks for a username and password; credential entry is deliberately omitted.
  4. Keycloak confirms Device Login Successful in that same completed session.
  5. The same native SMART CLI session returns Signed in to SMART and confirms the skills:sokit and tools:sokit roles.
Local SMART service

Start the local SMART MCP service for the signed-in environment.

smart mcp start

Show whether the local SMART MCP service is running and how clients can reach it.

smart mcp status

Stop the local SMART MCP service without removing agent integrations.

smart mcp stop
Agent integrations

Connect Codex to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate codex on

Remove only SMART-owned entries from the Codex integration.

smart mcp integrate codex off

Connect Claude Code to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate claude on

Remove only SMART-owned entries from the Claude Code integration.

smart mcp integrate claude off

Connect Cursor to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate cursor on

Remove only SMART-owned entries from the Cursor integration.

smart mcp integrate cursor off

Connect Cline to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate cline on

Remove only SMART-owned entries from the Cline integration.

smart mcp integrate cline off

Connect Gemini CLI to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate gemini-cli on

Remove only SMART-owned entries from the Gemini CLI integration.

smart mcp integrate gemini-cli off

Connect GitHub Copilot CLI to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate github-copilot-cli on

Remove only SMART-owned entries from the GitHub Copilot CLI integration.

smart mcp integrate github-copilot-cli off

Connect Windsurf to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate windsurf on

Remove only SMART-owned entries from the Windsurf integration.

smart mcp integrate windsurf off

Connect Zed to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate zed on

Remove only SMART-owned entries from the Zed integration.

smart mcp integrate zed off

Connect VS Code to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate vscode on

Remove only SMART-owned entries from the VS Code integration.

smart mcp integrate vscode off

Connect JetBrains to the local SMART MCP service while preserving unrelated configuration.

smart mcp integrate jetbrains on

Remove only SMART-owned entries from the JetBrains integration.

smart mcp integrate jetbrains off
Shell completion

Generate command completion definitions for the bash shell.

smart completion bash

Generate command completion definitions for the zsh shell.

smart completion zsh

Generate command completion definitions for the fish shell.

smart completion fish

Generate command completion definitions for the pwsh shell.

smart completion pwsh

Generate command completion definitions for the nu shell.

smart completion nu
Removal

Stop SMART and remove its managed agent integrations and local service files.

smart mcp uninstall
Machine-readable output

Return authentication status as JSON for scripts and development tooling.

smart auth status --json

Return local SMART MCP service status as JSON for scripts and health checks.

smart mcp status --json
Help and version

List SMART command groups and the options available for each one.

smart help

Show the same top-level command help using the standard flag form.

smart --help

Print the installed SMART CLI version.

smart version

Print the installed SMART CLI version using the standard flag form.

smart --version