Referência da CLI
Cada comando e flag da @valorbrain/cli publicada, gerado do help --json.
Gerada de help --json da @valorbrain/cli, versão 0.2.2 (a versão latest no npm no build destes docs) por scripts/generate-reference.py. Não edite à mão: o texto abaixo é a saída da CLI. Para o fluxo de conexão, veja o Quickstart e CLI.
Rodar sem instalar:
npx -y @valorbrain/cli@latest <command>Padrões
| Config local | ~/.valorbrain/config.json |
| REST padrão | https://valorbrain-api.valor.digital |
| MCP padrão | https://mcpbrain.valor.digital/mcp |
Flags globais
| Flag | Apelidos | Descrição |
|---|---|---|
--json | — | machine-readable single-object output; errors too |
--api-key | — | REST API key (vb_agent_… or vb_…) override |
--key | — | alias of --api-key (on add, after the command, --key is the memory key) |
--url | — | REST base URL override (on mcp: the MCP URL) |
--agent | — | init only: create an agent account |
--help | -h | this help |
--version | -V | print the version |
Comandos
init
create an agent account (REST key + MCP token) or claim it with an email
npx -y @valorbrain/cli init --agent [--agent-caller <platform>] [--name <n>] [--force]
npx -y @valorbrain/cli init --email <address> [--otp <code>]identify
set which agent is calling (idempotent)
npx -y @valorbrain/cli identify <platform>add
store a memory; --key gives it a stable identity, so adding again is a revision
npx -y @valorbrain/cli add <text>
npx -y @valorbrain/cli --file <path> [--key <name>] [--collection <c>] [--title <t>] [--type <t>] [--supersedes <docid|path>] [--sensitivity <s>]search
search memories
npx -y @valorbrain/cli search <query> [--collection <c>] [--mode <m>] [--limit <n>]forget
forget a memory (soft delete; it stops appearing in search)
npx -y @valorbrain/cli forget <docid>list
list collections
npx -y @valorbrain/cli liststatus
local config + remote health
npx -y @valorbrain/cli statusmcp
bridge stdio MCP clients to the hosted MCP server (uses the saved mcp_token)
npx -y @valorbrain/cli mcp [--token vbm_…] [--token-file <path>] [--url <mcp-url>]help
this surface, machine-readable with --json
npx -y @valorbrain/cli help [--json]version
print the version
npx -y @valorbrain/cli versionDump de máquina: /cli-help.json.