Installation
Install the @broomva/cli to manage prompts, skills, and agent context from your terminal.
Installing the CLI
The BroomVA CLI (@broomva/cli) is a command-line interface for managing prompts, skills, authentication, and agent context. It is built with Commander.js v14 and published as an npm package.
Requirements
- Node.js 18 or later (LTS recommended)
- npm, yarn, pnpm, or bun package manager
- A terminal emulator (the CLI uses colored output via ANSI escape codes; pass
--no-colorto disable)
Installation
Global install (recommended)
Install the CLI globally so the broomva command is available everywhere:
# npm
npm install -g @broomva/cli
# bun (recommended)
bun install -g @broomva/cli
# pnpm
pnpm install -g @broomva/cli
# yarn
yarn global add @broomva/clinpx (no install)
Run the CLI directly without installing:
npx @broomva/cli --helpFrom source
If you are contributing to the CLI or want the latest development version:
git clone https://github.com/broomva/broomva.tech.git
cd broomva.tech/packages/cli
bun install
bun run build
bun linkThis builds the CLI with tsup and links it globally so broomva resolves to your local build. The binary entry point is dist/index.js.
The CLI is part of the broomva.tech Turborepo monorepo. Building from source requires Bun (the monorepo's package manager). The CLI itself has minimal dependencies: commander (v14) and zod (v3.24) at runtime.
Verify installation
broomva --version
# 0.1.0
broomva --help
# Usage: broomva [options] [command]
#
# CLI for broomva.tech — prompts, skills, and context
#
# Options:
# -V, --version output the version number
# --api-base <url> API base URL
# --token <token> API token
# --no-color Disable color output
# -h, --help display help for command
#
# Commands:
# auth Manage authentication
# prompts Manage prompts
# skills Browse and install skills
# context Show project context and conventions
# config Manage CLI configuration
# daemon Manage the broomvad runtime daemonPackage details
| Field | Value |
|---|---|
| Package name | @broomva/cli |
| Version | 0.1.0 |
| Binary name | broomva |
| Module type | ESM ("type": "module") |
| Build tool | tsup |
| Test framework | Vitest |
| Linter | Biome |
| License | MIT |
Configuration
The CLI stores its configuration in ~/.broomva/config.json. You can set defaults with the config command:
# Set the API base URL (default: https://broomva.tech)
broomva config set apiBase https://broomva.tech
# Set the default output format
broomva config set defaultFormat json
# View current configuration
broomva config getConfiguration values can be overridden per-command with flags:
broomva --api-base http://localhost:3001 prompts listDaemon configuration
The daemon command has additional configurable keys under the daemon.* namespace:
| Key | Type | Default | Description |
|---|---|---|---|
daemon.heartbeatIntervalMs | number | 30000 | Interval between health check ticks |
daemon.dashboardPort | number | 4200 | Local dashboard HTTP port |
daemon.symphonyUrl | string | -- | Symphony orchestration service URL |
daemon.arcanUrl | string | -- | Arcan agent runtime URL |
daemon.lagoUrl | string | -- | Lago persistence URL |
daemon.autonomicUrl | string | -- | Autonomic controller URL |
daemon.incidentThreshold | number | 3 | Consecutive failures before opening an incident |
# Configure daemon heartbeat interval
broomva config set daemon.heartbeatIntervalMs 15000
# Point daemon at local services
broomva config set daemon.arcanUrl http://localhost:8081Environment variables
The CLI also reads configuration from environment variables:
| Variable | Purpose | Default |
|---|---|---|
BROOMVA_TOKEN | API token (skips auth login) | -- |
BROOMVA_API_BASE | API base URL | https://broomva.tech |
Environment variables take precedence over the config file, and command-line flags take precedence over both. The resolution order is:
--token/--api-basecommand-line flagsBROOMVA_TOKEN/BROOMVA_API_BASEenvironment variables- Values in
~/.broomva/config.json - Built-in defaults
Next steps
- Authenticate with the platform
- Browse the full command reference