> ## 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

> Command-line interface for the BRICKS Workspace API

[BRICKS](https://bricks.tools) 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](/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
* **Work with projects** — scaffold, compile, deploy, and simulate bricks-ctor projects with `bricks ctor`
* **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](/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:

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://cdn.bricks.tools/bricks-cli/release/install.sh | sh
  ```

  ```powershell Windows theme={null}
  irm https://cdn.bricks.tools/bricks-cli/release/install.ps1 | iex
  ```
</CodeGroup>

See the [installation guide](/cli/installation) for direct downloads, npm/Bun installs, and the beta channel.

## Quick start

```bash theme={null}
# 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

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/cli/installation">
    Install the CLI on macOS, Linux, or Windows.
  </Card>

  <Card title="Authentication" icon="key" href="/cli/authentication">
    Set up profiles and manage workspace credentials.
  </Card>

  <Card title="Command reference" icon="book" href="/cli/commands">
    Full reference for every CLI command and option.
  </Card>
</CardGroup>