Generated CLI Reference

Generated from Commander command declarations in apps/agents-synapsex/shared/cli/src.

Package: synapsex-cli
Version: 0.1.0
Parsed command entries: 50

Install

npm install -g synapsex-cli
synapsex --help

Commands

`synapsex agent`

Manage AI agents Source: src/commands/agent.ts

`synapsex agent create`

Create a new AI agent Arguments:

Argument	Description
`<name>`	Agent name

Options:

Option	Description	Default
`-p, --provider <provider>`	LLM provider to use	“
`-m, --model <model>`	AI model to use	“
`-t, --tools <tools...>`	Tools to enable	“
`-d, --description <text>`	Agent description	“

Source: src/commands/agent.ts

`synapsex agent list`

List all agents Options:

Option	Description	Default
`-q, --quiet`	Only show IDs	“

Source: src/commands/agent.ts

`synapsex agent status`

Check agent status Arguments:

Argument	Description
`<id>`	Agent ID or name

Source: src/commands/agent.ts

`synapsex agent logs`

Stream agent logs Arguments:

Argument	Description
`<id>`	Agent ID or name

Options:

Option	Description	Default
`-n, --lines <count>`	Number of recent lines to show	`50`

Source: src/commands/agent.ts

`synapsex agent delete`

Delete an agent Arguments:

Argument	Description
`<id>`	Agent ID or name

Options:

Option	Description	Default
`-f, --force`	Skip confirmation	“

Source: src/commands/agent.ts

`synapsex agent invoke`

Invoke an agent with input Arguments:

Argument	Description
`<id>`	Agent ID or name
`<input>`	Input text

Options:

Option	Description	Default
`-s, --stream`	Stream output	“

Source: src/commands/agent.ts

`synapsex config`

Manage SynapseX configuration Source: src/commands/config.ts

`synapsex config get`

Get configuration value Arguments:

Argument	Description
`<key>`	Configuration key

Source: src/commands/config.ts

`synapsex config set`

Set configuration value Arguments:

Argument	Description
`<key>`	Configuration key
`<value>`	Configuration value

Source: src/commands/config.ts

`synapsex config list`

List all configuration Source: src/commands/config.ts

`synapsex config clear`

Clear configuration Source: src/commands/config.ts

`synapsex deploy`

Deploy agents to SynapseX cloud Source: src/commands/deploy.ts

`synapsex deploy local`

Run agent locally with Docker Arguments:

Argument	Description
`<agent-id>`	Agent ID or name

Options:

Option	Description	Default
`-p, --port <port>`	Port to expose	`8080`

Source: src/commands/deploy.ts

`synapsex deploy cloud`

Deploy agent to SynapseX cloud Arguments:

Argument	Description
`<agent-id>`	Agent ID or name

Source: src/commands/deploy.ts

`synapsex init`

Initialize SynapseX in a repository Options:

Option	Description	Default
`--repo <url>`	Git repository URL	“

Source: src/commands/init.ts

`synapsex jobs`

Manage jobs Source: src/commands/jobs.ts

`synapsex jobs submit <title>`

Submit a new job Options:

Option	Description	Default
`--agent <agent-id>`	Agent ID	“
`--tenant <tenant-id>`	Tenant ID	“
`--type <type>`	Job type	`general`
`--priority <priority>`	Priority (1-10)	`5`

Source: src/commands/jobs.ts

`synapsex jobs list`

List jobs Options:

Option	Description	Default
`--agent <agent-id>`	Filter by agent	“
`--status <status>`	Filter by status	“

Source: src/commands/jobs.ts

`synapsex jobs cancel <job-id>`

Cancel a job Source: src/commands/jobs.ts

`synapsex jobs status <job-id>`

Get job status Source: src/commands/jobs.ts

`synapsex mcp`

Manage MCP tools and registries Source: src/commands/mcp.ts

`synapsex mcp list`

List available MCP tools Options:

Option	Description	Default
`-c, --category <name>`	Filter by category	“

Source: src/commands/mcp.ts

`synapsex mcp info`

Get tool details Arguments:

Argument	Description
`<name>`	Tool name

Source: src/commands/mcp.ts

`synapsex mcp add`

Add MCP registry Arguments:

Argument	Description
`<url>`	Registry URL

Options:

Option	Description	Default
`-n, --name <name>`	Registry name	“

Source: src/commands/mcp.ts

`synapsex mcp route`

Select the best MCP/tool for a natural-language request Arguments:

Argument	Description
`<input>`	Natural-language request

Options:

Option	Description	Default
`--preferred <name>`	Preferred MCP server name	“
`--tenant <id>`	Tenant ID	“
`--json`	Print JSON output	“

Source: src/commands/mcp.ts

`synapsex mcp plan`

Create an explainable MCP execution plan Arguments:

Argument	Description
`<input>`	Natural-language request

Options:

Option	Description	Default
`--preferred <name>`	Preferred MCP server name	“
`--tenant <id>`	Tenant ID	“
`--json`	Print JSON output	“

Source: src/commands/mcp.ts

`synapsex mcp ask`

Plan or execute an MCP-backed request intelligently Arguments:

Argument	Description
`<input>`	Natural-language request

Options:

Option	Description	Default
`--preferred <name>`	Preferred MCP server name	“
`--tenant <id>`	Tenant ID	“
`--approve`	Approve execution when required	“
`--mode <mode>`	auto or plan	`auto`
`--tool <name>`	Force tool name	“
`--tool-input <json>`	Structured tool input JSON	“
`--vm <id>`	Target VM ID for VM-backed MCP tools	“
`--timeout <seconds>`	Execution timeout seconds	`30`
`--json`	Print JSON output	“

Source: src/commands/mcp.ts

`synapsex providers`

Configure LLM providers for SynapseX agents Source: src/commands/providers.ts

`synapsex providers setup`

Configure an LLM provider Options:

Option	Description	Default
`-m, --model <model>`	Default model for this provider	“
`--api-key-env <name>`	Environment variable that stores the API key	“
`--base-url <url>`	Custom provider base URL	“
`--default`	Use this provider as the default for new agents	“

Source: src/commands/providers.ts

`synapsex providers use`

Set the default provider and model for new agents Arguments:

Argument	Description
`<provider>`	Provider name

Options:

Option	Description	Default
`-m, --model <model>`	Default model	“

Source: src/commands/providers.ts

`synapsex providers list`

List configured LLM providers Source: src/commands/providers.ts

`synapsex merge`

No description. Arguments:

Argument	Description
`<agent-id>`	Agent ID

Options:

Option	Description	Default
`--strategy <strategy>`	Merge strategy (squash, merge, rebase)	`squash`

Source: src/commands/workflow.ts

`synapsex promote`

Push agent branch and open PR Arguments:

Argument	Description
`<agent-id>`	Agent ID

Source: src/commands/workflow.ts

`synapsex billing`

Manage billing and subscription Source: src/commands/workflow.ts

`synapsex billing status`

Check billing status Source: src/commands/workflow.ts

`synapsex billing quota`

Check quota and usage Options:

Option	Description	Default
`--agent <agent-id>`	Check quota for specific agent	“

Source: src/commands/workflow.ts

`synapsex billing history`

View credit transaction history Options:

Option	Description	Default
`--limit <number>`	Number of transactions	`20`

Source: src/commands/workflow.ts

`synapsex billing plans`

List available plans Source: src/commands/workflow.ts

`synapsex webhooks`

Manage webhooks Source: src/commands/workflow.ts

`synapsex webhooks create <url>`

Create a webhook subscription Options:

Option	Description	Default
`--entity <entity-id>`	Entity ID	“
`--app <app-id>`	App ID	“
`--action <action>`	Action filter	“

Source: src/commands/workflow.ts

`synapsex webhooks list`

List webhooks Options:

Option	Description	Default
`--entity <entity-id>`	Entity ID	“

Source: src/commands/workflow.ts

`synapsex integrations`

Manage integrations Source: src/commands/workflow.ts

`synapsex integrations list`

List available integrations Source: src/commands/workflow.ts

`synapsex integrations connect <provider>`

Connect an integration Options:

Option	Description	Default
`--entity <entity-id>`	Entity ID	“

Source: src/commands/workflow.ts

`synapsex server`

Manage orchestrator server Source: src/commands/workflow.ts

`synapsex server start`

Start the orchestrator server Source: src/commands/workflow.ts

`synapsex server status`

Check server health Source: src/commands/workflow.ts

`synapsex workflow`

Run multi-agent workflows Arguments:

Argument	Description
`<description>`	Workflow description

Options:

Option	Description	Default
`--agents <agents>`	Comma-separated agent profiles	`planner,coder,reviewer,tester`
`--budget <budget>`	Total budget USD	`5.0`
`--model <model>`	LLM model	`claude-sonnet-4-6`

Source: src/commands/workflow.ts

`synapsex run`

Run an agent interactively Arguments:

Argument	Description
`<agent-id>`	Agent ID or name

Options:

Option	Description	Default
`-i, --input <text>`	Input to pass to the agent	“
`-s, --stream`	Stream output in real-time	“

Source: src/index.ts

​Generated CLI Reference

​Install

​Commands

​synapsex agent

​synapsex agent create

​synapsex agent list

​synapsex agent status

​synapsex agent logs

​synapsex agent delete

​synapsex agent invoke

​synapsex config

​synapsex config get

​synapsex config set

​synapsex config list

​synapsex config clear

​synapsex deploy

​synapsex deploy local

​synapsex deploy cloud

​synapsex init

​synapsex jobs

​synapsex jobs submit <title>

​synapsex jobs list

​synapsex jobs cancel <job-id>

​synapsex jobs status <job-id>

​synapsex mcp

​synapsex mcp list

​synapsex mcp info

​synapsex mcp add

​synapsex mcp route

​synapsex mcp plan

​synapsex mcp ask

​synapsex providers

​synapsex providers setup

​synapsex providers use

​synapsex providers list

​synapsex merge

​synapsex promote

​synapsex billing

​synapsex billing status

​synapsex billing quota

​synapsex billing history

​synapsex billing plans

​synapsex webhooks

​synapsex webhooks create <url>

​synapsex webhooks list

​synapsex integrations

​synapsex integrations list

​synapsex integrations connect <provider>

​synapsex server

​synapsex server start

​synapsex server status

​synapsex workflow

​synapsex run

Generated CLI Reference

Install

Commands

`synapsex agent`

`synapsex agent create`

`synapsex agent list`

`synapsex agent status`

`synapsex agent logs`

`synapsex agent delete`

`synapsex agent invoke`

`synapsex config`

`synapsex config get`

`synapsex config set`

`synapsex config list`

`synapsex config clear`

`synapsex deploy`

`synapsex deploy local`

`synapsex deploy cloud`

`synapsex init`

`synapsex jobs`

`synapsex jobs submit <title>`

`synapsex jobs list`

`synapsex jobs cancel <job-id>`

`synapsex jobs status <job-id>`

`synapsex mcp`

`synapsex mcp list`

`synapsex mcp info`

`synapsex mcp add`

`synapsex mcp route`

`synapsex mcp plan`

`synapsex mcp ask`

`synapsex providers`

`synapsex providers setup`

`synapsex providers use`

`synapsex providers list`

`synapsex merge`

`synapsex promote`

`synapsex billing`

`synapsex billing status`

`synapsex billing quota`

`synapsex billing history`

`synapsex billing plans`

`synapsex webhooks`

`synapsex webhooks create <url>`

`synapsex webhooks list`

`synapsex integrations`

`synapsex integrations list`

`synapsex integrations connect <provider>`

`synapsex server`

`synapsex server start`

`synapsex server status`

`synapsex workflow`

`synapsex run`