The agent command provides sub-commands for managing your deployed agents. These commands allow you to view status, start instances, see logs, and manage deployments.

​
start

Start a deployed agent instance, creating an active session.

Usage:

pcc agent start [ARGS] [OPTIONS]

Arguments:

​
agent-name
string
required

Unique string identifier for the agent deployment. Must not contain spaces.

Options:

​
--api-key / -k
string

Public API key to authenticate the agent deployment. Will default to any key set in your config.

For more information, see API keys.

​
--data / -d
string

Stringified JSON object to pass to the agent deployment. This data will be available to the agent as a data parameter in your bot() method.

More information here.

​
--force / -f
boolean
default:"false"

Skip summary confirmation before issuing start request.

​
--use-daily / -D
boolean
default:"false"

Create a Daily WebRTC session for the agent.

​
--organization / -o
str

Organization to start the agent for. If not provided, uses the current organization from your configuration.

​
status

Shows the current status of an agent deployment, including health and conditions.

Usage:

pcc agent status [ARGS]

Arguments:

​
agent-name
string
required

Unique string identifier for the agent deployment. Must not contain spaces.

​
deployments

Lists deployment history for an agent, including image versions and timestamps.

Usage:

pcc agent deployments [ARGS]

Arguments:

​
agent-name
string
required

Unique string identifier for the agent deployment. Must not contain spaces.

​
logs

Displays combined logs from all agent instances, useful for debugging issues.

Usage:

pcc agent logs [ARGS]

Arguments:

​
agent-name
string
required

Unique string identifier for the agent deployment. Must not contain spaces.

Options:

​
--level / -l
string
default:"ALL"

Filter logs by severity: ALL, DEBUG, INFO, WARNING, ERROR, CRITICAL.

​
--limit / -n
int
default:"100"

Limit the number of log lines to display.

​
list

Lists all agents in an organization with their details.

Usage:

pcc agent list [OPTIONS]

Options:

​
--organization / -o
string

Organization to list agents for. If not provided, uses the current organization from your configuration.

​
sessions

Lists active sessions for a specified agent. When there are no active sessions, it suggests how to start a new session.

Usage:

pcc agent sessions [ARGS] [OPTIONS]

Arguments:

​
agent-name
string
required

Name of the agent to list active sessions for.

Options:

​
--organization / -o
string

Organization to list sessions for. If not provided, uses the current organization from your configuration.

​
delete

Deletes an agent deployment. This will prevent starting new instances and remove all associated data.

This action is irreversible. All data will be lost.

Usage:

pcc agent delete [ARGS]

Arguments:

​
agent-name
string
required

Unique string identifier for the agent deployment. Must not contain spaces.

Options:

​
--force / -f
string

Do not prompt for confirmation before deleting the agent.

Overviewauth