Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bricks.tools/llms.txt

Use this file to discover all available pages before exploring further.

BRICKS CLI is a command-line tool for managing your BRICKS workspace. It provides full control over BRICKS Foundation devices, applications, modules, and media — directly from the terminal.

​
What you can do

  • Manage BRICKS Foundation — list, monitor, control, take screenshots, and dispatch group actions (see BRICKS Foundation for device setup)
  • Build applications — create, update, release, and deploy BRICKS applications
  • Work with modules — create reusable modules and manage their lifecycle
  • Upload media — upload files to Media Flow with tagging, AI analysis, and image processing
  • Initialize projects — scaffold bricks-ctor codebases from existing applications or modules
  • Interactive mode — browse and control your workspace in a terminal UI
  • DevTools — discover devices on your local network, inspect brick components, capture screenshots, emulate input, monitor network activity, and inspect storage via CDP
  • Pair Buttress servers — bind a BRICKS Buttress server to your workspace and issue access tokens
  • MCP server — expose workspace tools to AI agents via the Model Context Protocol

​
Installation

Install the native standalone binary with one command: 
curl -fsSL https://cdn.bricks.tools/bricks-cli/release/install.sh | sh
See the installation guide for direct downloads, npm/Bun installs, and the beta channel.

​
Quick start

# Login with a one-time passcode from BRICKS Controller
bricks auth login <passcode>

# List your BRICKS Foundation devices
bricks device list

# List your applications
bricks app list

# Launch interactive mode
bricks interactive

​
Next steps

Installation

Install the CLI on macOS, Linux, or Windows.

Authentication

Set up profiles and manage workspace credentials.

Command reference

Full reference for every CLI command and option.