Skip to main content

Agent CLI

Manage agent extensions

These commands manage CodeBolt extensions. Most of them create a temporary local server context through executeAction() before calling the extension endpoints.

This same command group is also mounted at the top level as codebolt agent ....

Subcommands

SubcommandDescriptionArgsOptions
createCreate a new agent from a template09
publishPublish an agent to the CodeBolt registry02
listList all published agents00
create-remoteCreate a remote agent (self-executed or CodeBolt-executed)05

create

Create a new agent from a template

codebolt action agent create [options]
codebolt agent create [options]

Arguments

This command takes no positional arguments.

Options

FlagsRequiredDescription
--name <name>NoName for the new agent
--path <path>NoTarget directory
--project <path>NoProject directory for server context
--template <name>NoTemplate to use
--id <id>NoUnique identifier
--description <text>NoDescription of the agent
--skip-installNoSkip npm install after creation
--remixNoCreate a remix of an existing agent (interactive)
--frameworkNoCreate a framework agent using the agent template

publish

Publish an agent to the CodeBolt registry

codebolt action agent publish [options]
codebolt agent publish [options]

Arguments

This command takes no positional arguments.

Options

FlagsRequiredDescription
--path <path>NoPath to agent directory
--project <path>NoProject directory for server context

list

List all published agents

codebolt action agent list
codebolt agent list

Arguments

This command takes no positional arguments.

Options

This command takes no options.

create-remote

Create a remote agent (self-executed or CodeBolt-executed)

codebolt action agent create-remote [options]
codebolt agent create-remote [options]

Arguments

This command takes no positional arguments.

Options

FlagsRequiredDescription
--name <name>YesName for the remote agent
--execution-mode <mode>YesExecution mode: selfExecuted or codeboltExecuted
--remote-path <path>NoAbsolute path to the remote agent (required for codeboltExecuted)
--description <text>NoDescription of the agent
--project <path>NoProject directory for server context