bdy agent install

$bdy agent install [options]

Install the agent as a system service or as a user application

OPTIONS

--context <name>

Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation.

--examples

Show only examples; with this flag --format accepts text, json or jsonl

--verbose

Show REST API requests, responses, timing and retries on stderr

-s, --start [true|false]

Start agent right away (default: "true")

-i, --id <id>

Start existing agent

-t, --token <token>

token to authorize existing agent agent or token to add a new agent

-p, --port <port>

Agent API port (default: "7456")

-u, --user <user>

OS user name. Default: root (macOS/Linux), LocalSystem (Windows. Provide as DOMAIN\USER (use whoami to get full username)

-a, --app

Starts bdy agent as standalone process, needs no administrator rights

--pass <password>

Password of the user. Only set for Windows

--target

Makes the agent available as a target

--proxy

Makes the agent available as a proxy

--no-tunnels

Stop all tunnels from working in agent

--tag <tag...>

Tag agent. Can be passed multiple times

-d, --debug

Turns on debug mode

--note <note>

Resource note

--agent-note <note>

Note for AI agents operating on this resource; stored as agent_note and meant to be read before acting on the resource

--format <text|json>

Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json")

-h, --help

display help for command

Documentation for bdy v1.25.20

Last modified on Oct 14, 2026