The agent command provides functionality to create, manage, and run agents that analyze incidents and alerts, leveraging the infrastructure knowledge graph and LLM capabilities.

​
Usage

unpage agent [OPTIONS] COMMAND [ARGS]...

​
Commands

CommandDescription
createCreate a new agent configuration file and open it in your editor
deleteDelete an agent
editEdit an existing agent configuration file
listList the available agents
quickstartGet up-and-running with an incident agent in <5min!
routeDetermine which agent will be used to analyze the given payload
runRun an agent with the provided payload and print the analysis
serveRun the Unpage Agent server to automatically process incoming alerts
templatesList the available agent templates

​
Subcommand: create

Creates a new agent configuration file based on available templates and opens it in your default editor.

​
Usage

unpage agent create [OPTIONS] AGENT_NAME

​
Options

OptionDescription
--profile TEXTUse profiles to manage multiple graphs [env var: UNPAGE_PROFILE] [default: default]
--overwriteOverwrite the agent file if it already exists
--template TEXTThe template to use to create the agent file [default: default]
--editor TEXTThe editor to use to open the agent file [default: from $EDITOR env var]
--no-editDo not open the agent file in your editor
-h, --helpShow help message and exit

​
Subcommand: delete

Deletes an existing agent.

​
Usage

unpage agent delete [OPTIONS] AGENT_NAME

​
Subcommand: edit

Opens an existing agent configuration file in your default editor.

​
Usage

unpage agent edit [OPTIONS] AGENT_NAME

​
Subcommand: list

Lists all available agents in your Unpage instance.

​
Usage

unpage agent list [OPTIONS]

​
Subcommand: quickstart

Launches an interactive wizard to quickly set up an incident response agent.

​
Usage

unpage agent quickstart [OPTIONS]

​
Subcommand: route

Tests which agent would be selected to analyze a given payload based on your routing configuration.

​
Usage

unpage agent route [OPTIONS] [PAYLOAD]

​
Subcommand: run

Executes an agent with a provided payload and displays the analysis.

​
Usage

unpage agent run [OPTIONS] AGENT_NAME [PAYLOAD]

​
Options

OptionDescription
--profile TEXTUse profiles to manage multiple graphs [env var: UNPAGE_PROFILE] [default: default]
--debugEnable debug mode to print the history of the agent
--pagerduty-incident TEXTPagerDuty incident ID or URL to use instead of payload or stdin
-h, --helpShow help message and exit

​
Examples: Running an Agent with a Test Payload

# Run an agent with a JSON payload from a file
unpage agent run my-agent @path/to/payload.json

# Run an agent with a JSON payload provided directly
unpage agent run my-agent '{"alert": "Disk usage exceeds 80%"}'

​
Subcommand: serve

Starts the Unpage Agent server, which listens for incoming alerts and routes them to appropriate agents. This creates a webhook receiver that can process alerts from various systems (like PagerDuty) and intelligently selects the most appropriate agent to analyze them.

​
Usage

unpage agent serve [OPTIONS]

​
Options

OptionDefaultDescription
--host TEXT127.0.0.1The host to bind to
--port INTEGER8000The port to bind to
--workers INTEGER1The number of workers to use
--profile TEXTdefaultThe profile to use for configuration
--reload / --no-reloadFalseReload the server when code changes
--tunnel / --no-tunnelFalseTunnel the server through ngrok for external access
--ngrok-token TEXTFrom env varThe ngrok token for tunneling
--ngrok-domain TEXTNoneThe ngrok domain for tunneling

​
Server Functionality

When running, the agent server:
  1. Exposes a /webhook endpoint that receives alert payloads as JSON via POST requests
  2. Automatically selects the most appropriate agent based on the incoming payload
  3. Processes the alert using the agent’s configuration and LLM capabilities
  4. Returns an analysis of the alert

​
Examples

# Start the agent server with default settings (localhost:8000)
unpage agent serve

# Start the server on a custom host and port
unpage agent serve --host 0.0.0.0 --port 9000

# Start the server with hot-reloading for development
unpage agent serve --reload

# Start the server and expose it externally using ngrok
unpage agent serve --tunnel --ngrok-token your_ngrok_token

​
Subcommand: templates

Lists all available agent templates that can be used when creating a new agent.

​
Usage

unpage agent templates [OPTIONS]