everruns agents
Applies toFramework (not available)Self-hostedEverruns Cloud
Agent definitions and their configuration.
| Command | What it does |
|---|---|
agents import | Import a portable agent file, folder or ZIP. |
agents export | Export an agent by name without IDs or credentials. |
agents validate | Validate a package locally, or also check destination dependencies. |
agents diff | Generate a semantic diff against a local package or a remote agent. |
agents create | Create a new agent (upserts if id: is present in frontmatter) |
agents update | Update an existing agent from a file definition. |
agents analyze | Run advisory checks (built-in rules plus LLM analysis) against an agent configuration. |
agents check-name | Check whether an agent name is available. |
agents copy | Copy an agent. |
agents delete | Archive an agent (soft delete). |
agents destroy | Permanently delete an archived agent. |
agents draft | Revise an agent draft from a conversation with the agent builder. |
agents get | Get a single agent by ID or name. |
agents list | List all active agents. |
agents preview | Preview the final agent shape with capabilities applied. |
agents upsert | Upsert agent — create (201) or update (200) by ID. |
agents channels create | Create an ingress channel for an agent. |
agents channels delete | Delete an agent ingress channel. |
agents channels get | Get an agent ingress channel. |
agents channels list | List an agent’s ingress channels. |
agents channels publish | Publish an agent ingress channel. |
agents channels trigger | Run an agent schedule channel now. |
agents channels unpublish | Unpublish an agent ingress channel. |
agents channels update | Update an agent ingress channel. |
agents channels keys create | Create an agent key for an agent’s API channel. |
agents channels keys list | List the agent keys of an agent’s API channel. |
agents channels keys revoke | Revoke an agent key. |
agents channels keys rotate | Replace an agent key’s secret, keeping its id. |
agents check-rules delete | Delete an agent check rule (built-in override or custom rule). |
agents check-rules list | List the org’s agent check rules: built-in rules with their effective enabled/severity, plus custom rules. |
agents check-rules upsert | Create or update an agent check rule (built-in override or custom rule). |
agents credentials create | Create a write-only Agent credential setup requirement for one attached MCP tool parameter. |
agents exposures resume | Let an agent’s live channels accept traffic again. |
agents exposures suspend | Stop every channel on an agent from accepting traffic. |
agents health-checks get | Get a single agent health check run with its results. |
agents health-checks list | List recent health check runs for an agent. |
agents health-checks trigger | Run a behavioral health check (generated smoke tests) against an agent. |
agents health-checks latest get | Get the latest health check run for an agent, with a stale-config flag. |
agents scripts create | Create a saved shell script an agent owns. |
agents scripts delete | Archive a saved script and free its name. |
agents scripts get | Get a single saved script by id. |
agents scripts list | List an agent’s saved scripts with their bodies. |
agents scripts update | Update a saved script’s description, input schema or body. |
agents triggers create | Create a schedule or webhook trigger for an agent. |
agents triggers delete | Archive an agent trigger and remove its durable schedule. |
agents triggers get | Get a single agent trigger by id. |
agents triggers list | List an agent’s triggers. |
agents triggers trigger | Manually fire an agent trigger once. |
agents triggers update | Update an agent trigger. |
agents triggers deliveries list | List recent events delivered to an agent trigger: dispatched, filtered, duplicate or failed. |
agents triggers runs list | List recent execution outcomes for an agent trigger. |
agents import
Section titled “agents import”Import a portable agent file, folder or ZIP.
everruns agents import [OPTIONS] [PATH]| Flag | Description |
|---|---|
<PATH> | |
--content <CONTENT> | Inline definition (also supported by Platform Chat and MCP) |
--target <TARGET> | Explicit existing agent name to update. |
--format <FORMAT> |
agents export
Section titled “agents export”Export an agent by name without IDs or credentials.
everruns agents export [OPTIONS] <AGENT>| Flag | Description |
|---|---|
<AGENT> | Required. |
--format <FORMAT> | One of markdown, toml, yaml, json, zip, folder. |
--out <OUT> |
agents validate
Section titled “agents validate”Validate a package locally, or also check destination dependencies.
everruns agents validate [OPTIONS] <FILE>| Flag | Description |
|---|---|
<FILE> | Required. |
--remote |
agents diff
Section titled “agents diff”Generate a semantic diff against a local package or a remote agent.
everruns agents diff [OPTIONS] <FILE>| Flag | Description |
|---|---|
<FILE> | Required. |
--against <AGAINST> | |
--target <TARGET> |
agents create
Section titled “agents create”Create a new agent (upserts if id: is present in frontmatter)
everruns agents create [OPTIONS]| Flag | Description |
|---|---|
-f, --file <FILE> | TOML/YAML/JSON/Markdown file with agent definition. |
--initial-files-dir <INITIAL_FILES_DIR> | Directory of files to upload as initial_files (read-only by default) |
--writable | Make initial files writable (default: read-only) |
--name <NAME> | Agent name (required if no —file) |
--instructions <SYSTEM_PROMPT> | System prompt (required if no —file) |
--description <DESCRIPTION> | Agent description. |
--model <MODEL> | Default model ID (e.g. mod_xxx) |
-H, --harness <HARNESS> | Harness ID or name (e.g. harness_xxx or “generic”). Omit to default to the org’s generic harness. |
-t, --tag <TAG> | Tags (repeatable) Repeatable. |
agents update
Section titled “agents update”Update an existing agent from a file definition.
everruns agents update [OPTIONS] [AGENT_ID]| Flag | Description |
|---|---|
<AGENT_ID> | Agent ID (e.g. agent_xxx). If omitted, uses id from file frontmatter. |
-f, --file <FILE> | TOML/YAML/JSON/Markdown file with agent definition. |
--initial-files-dir <INITIAL_FILES_DIR> | Directory of files to upload as initial_files (read-only by default) |
--writable | Make initial files writable (default: read-only) |
--name <NAME> | Agent name. |
--instructions <SYSTEM_PROMPT> | System prompt. |
--description <DESCRIPTION> | Agent description. |
--model <MODEL> | Default model ID (e.g. mod_xxx) |
-H, --harness <HARNESS> | Harness ID or name (e.g. harness_xxx or “generic”) |
-t, --tag <TAG> | Tags (repeatable) Repeatable. |
agents analyze
Section titled “agents analyze”Run advisory checks (built-in rules plus LLM analysis) against an agent configuration.
everruns agents analyze [OPTIONS]| Flag | Description |
|---|---|
--capabilities <CAPABILITIES> | |
--harness-id <HARNESS_ID> | |
--initial-files <INITIAL_FILES> | |
--mcp-servers <MCP_SERVERS> | |
--system-prompt <SYSTEM_PROMPT> | |
--tools <TOOLS> |
Example:
# Check a draft configuration for problems before creating the agenteverruns agents analyze --system-prompt 'Triage incoming issues' --tools '["bash"]'agents check-name
Section titled “agents check-name”Check whether an agent name is available.
everruns agents check-name [OPTIONS] --name <name>| Flag | Description |
|---|---|
--exclude-id <EXCLUDE_ID> | |
--name <NAME> | Required. Human-readable name. |
Example:
# See whether a name is free before creating an agenteverruns agents check-name --name triageagents copy
Section titled “agents copy”Copy an agent. Generates a unique name.
everruns agents copy [OPTIONS] [ID]| Flag | Description |
|---|---|
--id <ID> | Prefixed public identifier. |
Example:
# Duplicate an agent to try a change without touching the originaleverruns agents copy agent_01h9 --reason 'Trial a stricter prompt'agents delete
Section titled “agents delete”Archive an agent (soft delete). Can be restored.
everruns agents delete [OPTIONS] [ID]| Flag | Description |
|---|---|
--id <ID> | Prefixed public identifier. |
Example:
# Archive an agent, keeping it restorableeverruns agents delete agent_01h9 --reason 'Replaced by triage-v2'agents destroy
Section titled “agents destroy”Permanently delete an archived agent.
everruns agents destroy [OPTIONS] [ID]| Flag | Description |
|---|---|
--id <ID> | Prefixed public identifier. |
Example:
# Permanently remove an already-archived agenteverruns agents destroy agent_01h9 --reason 'Retired after the archive window'agents draft
Section titled “agents draft”Revise an agent draft from a conversation with the agent builder. Returns the draft only; nothing is created.
everruns agents draft [OPTIONS] --messages <messages>| Flag | Description |
|---|---|
--draft <DRAFT> | |
--messages <MESSAGES> | Required. Conversation so far, oldest first. |
Example:
# Ask the builder for a first drafteverruns agents draft --messages '[{"role":"user","content":"Triage new GitHub issues every morning"}]'agents get
Section titled “agents get”Get a single agent by ID or name.
everruns agents get [OPTIONS] [ID]| Flag | Description |
|---|---|
--id <ID> | Prefixed public identifier. |
Example:
# Show one agent's full configurationeverruns agents get agent_01h9agents list
Section titled “agents list”List all active agents. Use search for name search, include_archived=true to include archived. Supports pagination (limit/offset).
everruns agents list [OPTIONS]| Flag | Description |
|---|---|
--include-archived | |
--limit <LIMIT> | Maximum number of items returned in this page. |
--offset <OFFSET> | Zero-based offset into the result set. |
--search <SEARCH> |
Example:
# Find agents by name when you do not know the ideverruns agents list --search triage --limit 20agents preview
Section titled “agents preview”Preview the final agent shape with capabilities applied.
everruns agents preview [OPTIONS]| Flag | Description |
|---|---|
--capabilities <CAPABILITIES> | |
--harness-id <HARNESS_ID> | |
--initial-files <INITIAL_FILES> | |
--mcp-servers <MCP_SERVERS> | |
--system-prompt <SYSTEM_PROMPT> | |
--tools <TOOLS> |
Example:
# See the prompt a draft configuration would produce, without creating iteverruns agents preview --system-prompt 'Triage incoming issues'agents upsert
Section titled “agents upsert”Upsert agent — create (201) or update (200) by ID.
everruns agents upsert [OPTIONS] --name <name> --system-prompt <system_prompt> [ID]| Flag | Description |
|---|---|
--id <ID> | Client-supplied agent ID (format: agent_{32-hex}). If not provided, one is auto-generated. |
--capabilities <CAPABILITIES> | Capabilities to enable for this agent with per-agent configuration. Each capability has a `re… |
--communication <COMMUNICATION> | How an agent talks to the people in its conversations. One of direct, explicit. |
--default-model-id <DEFAULT_MODEL_ID> | The ID of the default LLM model to use for this agent. If not specified, the system default m… |
--description <DESCRIPTION> | A human-readable description of what the agent does. |
--display-name <DISPLAY_NAME> | Human-readable display name shown in UI. Falls back to name when absent. |
-H, --harness <HARNESS_NAME> | Addressable harness name. |
--harness-id <HARNESS_ID> | Harness ID used as this agent’s base execution environment. |
--initial-files <INITIAL_FILES> | Starter files copied into each new session for this agent. |
--intro-markdown <INTRO_MARKDOWN> | Markdown intro shown as an intro box on a fresh Platform Chat thread. Images are allowed. |
--max-iterations <MAX_ITERATIONS> | Maximum number of LLM iterations per turn for this agent. |
--mcpServers <MCPSERVERS> | |
--name <NAME> | Required. Name, unique per org. |
--network-access <NETWORK_ACCESS> | |
--parallel-tool-calls | Request-level parallel tool calling preference (EVE-598). |
--sandbox-policy <SANDBOX_POLICY> | |
--service-virtual-user-id <SERVICE_VIRTUAL_USER_ID> | |
--short-description <SHORT_DESCRIPTION> | One-line description in simplified Markdown, shown below the chat title once the intro is hid… |
--starters <STARTERS> | Conversation starters for a fresh Platform Chat thread. |
--system-prompt <SYSTEM_PROMPT> | Required. The system prompt that defines the agent’s behavior and capabilities. This is sent as the fir… |
--tags <TAGS> | Tags for organizing and filtering agents. Repeatable. |
--tools <TOOLS> | Client-side tools for this agent. These tools are sent to the LLM but executed by the client,… |
Example:
# Create or replace an agent at a known id, for a scripted deployeverruns agents upsert agent_01h9 --name triage --system-prompt 'Triage incoming issues' --reason 'Deploy release 42'agents channels create
Section titled “agents channels create”Create an ingress channel for an agent.
everruns agents channels create [OPTIONS] --agent-id <agent_id> --channel-type <channel_type>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
--channel-config <CHANNEL_CONFIG> | Transport-specific channel configuration. |
--channel-type <CHANNEL_TYPE> | Required. Supported channel types for app distribution. One of slack, ag_ui, schedule, webhook, a2a, fcp, api_endpoint, public_chat, voice, api, poppy. |
--enabled | Whether the channel can accept ingress traffic. |
Example:
# Add a weekday-morning schedule that starts the agent on its owneverruns agents channels create --agent-id agent_01h9 --channel-type schedule --channel-config '{"cron_expression":"0 9 * * 1-5","message":"Summarize overnight alerts"}' --reason 'Daily alert digest'agents channels delete
Section titled “agents channels delete”Delete an agent ingress channel.
everruns agents channels delete [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
--channel-id <CHANNEL_ID> | Required. Channel’s prefixed public identifier. |
Example:
# Remove a channel the agent should no longer be reachable througheverruns agents channels delete --agent-id agent_01h9 --channel-id appchan_01h9 --reason 'Schedule replaced by a webhook'agents channels get
Section titled “agents channels get”Get an agent ingress channel.
everruns agents channels get [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
--channel-id <CHANNEL_ID> | Required. Channel’s prefixed public identifier. |
Example:
# Inspect one channel's configuration and whether it is liveeverruns agents channels get --agent-id agent_01h9 --channel-id appchan_01h9agents channels list
Section titled “agents channels list”List an agent’s ingress channels.
everruns agents channels list [OPTIONS] --agent-id <agent_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
Example:
# See every way an agent can be reached before adding anothereverruns agents channels list --agent-id agent_01h9agents channels publish
Section titled “agents channels publish”Publish an agent ingress channel.
everruns agents channels publish [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
--channel-id <CHANNEL_ID> | Required. Channel’s prefixed public identifier. |
Example:
# Make a reviewed channel live so it accepts trafficeverruns agents channels publish --agent-id agent_01h9 --channel-id appchan_01h9 --reason 'Config reviewed'agents channels trigger
Section titled “agents channels trigger”Run an agent schedule channel now.
everruns agents channels trigger [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
--channel-id <CHANNEL_ID> | Required. Prefixed public identifier of a schedule channel. |
Example:
# Run a schedule channel now instead of waiting for its next fire timeeverruns agents channels trigger --agent-id agent_01h9 --channel-id appchan_01h9 --reason 'Check the digest before the first scheduled run'agents channels unpublish
Section titled “agents channels unpublish”Unpublish an agent ingress channel.
everruns agents channels unpublish [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
--channel-id <CHANNEL_ID> | Required. Channel’s prefixed public identifier. |
Example:
# Take a channel offline without deleting its configurationeverruns agents channels unpublish --agent-id agent_01h9 --channel-id appchan_01h9 --reason 'Pause while the integration is reworked'agents channels update
Section titled “agents channels update”Update an agent ingress channel.
everruns agents channels update [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
--channel-config <CHANNEL_CONFIG> | Replacement transport-specific channel configuration. |
--channel-id <CHANNEL_ID> | Required. Channel’s prefixed public identifier. |
--enabled | Whether the channel can accept ingress traffic. |
Example:
# Pause a channel without deleting iteverruns agents channels update --agent-id agent_01h9 --channel-id appchan_01h9 --enabled false --reason 'Pause during the migration'agents channels keys create
Section titled “agents channels keys create”Create an agent key for an agent’s API channel. The secret is returned once.
everruns agents channels keys create [OPTIONS] --agent-id <agent_id> --channel-id <channel_id> --name <name>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. |
--channel-id <CHANNEL_ID> | Required. |
--expires-at <EXPIRES_AT> | When the key stops working. |
--name <NAME> | Required. Display name, e.g. |
Example:
# Give a backend service its own key to call the agenteverruns agents channels keys create --agent-id agent_01h9 --channel-id appchan_01h9 --name "Support backend" --reason "New support integration"agents channels keys list
Section titled “agents channels keys list”List the agent keys of an agent’s API channel. Secrets are never returned.
everruns agents channels keys list [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. |
--channel-id <CHANNEL_ID> | Required. |
Example:
# See which applications hold a key before rotating or revoking oneeverruns agents channels keys list --agent-id agent_01h9 --channel-id appchan_01h9agents channels keys revoke
Section titled “agents channels keys revoke”Revoke an agent key. It never works again, including a secret still in its rotation overlap.
everruns agents channels keys revoke [OPTIONS] --agent-id <agent_id> --channel-id <channel_id> --key-id <key_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. |
--channel-id <CHANNEL_ID> | Required. |
--key-id <KEY_ID> | Required. |
Example:
# Cut off a key that leaked, immediatelyeverruns agents channels keys revoke --agent-id agent_01h9 --channel-id appchan_01h9 --key-id agentkey_01h9 --reason "Key exposed in a log"agents channels keys rotate
Section titled “agents channels keys rotate”Replace an agent key’s secret, keeping its id. The new secret is returned once; the old one works for the overlap.
everruns agents channels keys rotate [OPTIONS] --agent-id <agent_id> --channel-id <channel_id> --key-id <key_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. |
--channel-id <CHANNEL_ID> | Required. |
--key-id <KEY_ID> | Required. |
--overlap-hours <OVERLAP_HOURS> | Hours the replaced secret keeps working (0 to 168, default 24). |
Example:
# Replace a key secret on schedule, keeping the old one valid for a dayeverruns agents channels keys rotate --agent-id agent_01h9 --channel-id appchan_01h9 --key-id agentkey_01h9 --overlap-hours 24 --reason "Quarterly rotation"agents check-rules delete
Section titled “agents check-rules delete”Delete an agent check rule (built-in override or custom rule).
everruns agents check-rules delete [OPTIONS] --rule-id <rule_id>| Flag | Description |
|---|---|
--rule-id <RULE_ID> | Required. Rule id to delete: a built-in rule id (clears its override) or custom.<slug>. |
Example:
# Drop a custom check rule that no longer applieseverruns agents check-rules delete --rule-id custom.no-pii --reason 'Covered by the org policy'agents check-rules list
Section titled “agents check-rules list”List the org’s agent check rules: built-in rules with their effective enabled/severity, plus custom rules.
everruns agents check-rules list [OPTIONS]Example:
# See which built-in and custom rules apply before changing oneeverruns agents check-rules listagents check-rules upsert
Section titled “agents check-rules upsert”Create or update an agent check rule (built-in override or custom rule).
everruns agents check-rules upsert [OPTIONS] --enabled [<enabled>] --kind <kind> --rule-id <rule_id>| Flag | Description |
|---|---|
--category <CATEGORY> | Finding category for custom rules: structure, completeness, effectiveness, safety, or… |
--enabled | Required. Whether the rule runs. |
--kind <KIND> | Required. builtin_override, declarative, or nl_rubric. |
--match-mode <MATCH_MODE> | forbidden (default) flags the prompt when the pattern is present; required flags it when … |
--message <MESSAGE> | Finding message a declarative rule reports when it triggers. |
--pattern <PATTERN> | Regex a declarative rule tests against the resolved prompt. |
--rubric <RUBRIC> | Natural-language criterion an nl_rubric rule asks the model to judge. |
--rule-id <RULE_ID> | Required. Built-in rule id (for builtin_override) or custom.<slug> (custom). |
--severity <SEVERITY> | Optional everywhere. |
Example:
# Add an LLM-judged rule that flags prompts handling personal dataeverruns agents check-rules upsert --rule-id custom.no-pii --kind nl_rubric --enabled true --category safety --severity warning --rubric 'Flag prompts that tell the agent to store customer personal data' --reason 'Privacy review requirement'agents credentials create
Section titled “agents credentials create”Create a write-only Agent credential setup requirement for one attached MCP tool parameter. This command never accepts a secret value; the user completes setup in the Agent Credentials UI.
everruns agents credentials create [OPTIONS] --label <label> --mcp-server-name <mcp_server_name> --parameter-name <parameter_name> --tool-name <tool_name>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Agent ID, populated from the request path by the HTTP API. |
--description <DESCRIPTION> | Optional explanation of how the credential will be used. |
--label <LABEL> | Required. Human-readable label shown in the secure setup UI. |
--mcp-server-name <MCP_SERVER_NAME> | Required. Name of an MCP server attached to the agent. |
--parameter-name <PARAMETER_NAME> | Required. Top-level tool argument to inject outside model context. |
--tool-name <TOOL_NAME> | Required. MCP tool whose outbound call requires the credential. |
Example:
# Declare that an MCP tool needs a secret the model must never seeeverruns agents credentials create --agent-id agent_01h9 --mcp-server-name visti --tool-name visti_send --parameter-name channel_key --label 'Visti channel key' --reason 'Notify the on-call channel'agents exposures resume
Section titled “agents exposures resume”Let an agent’s live channels accept traffic again.
everruns agents exposures resume [OPTIONS] [AGENT]| Flag | Description |
|---|---|
--agent <AGENT_ID> | Agent’s prefixed public identifier. |
Example:
# Put a suspended agent back on its exposed surfaceseverruns agents exposures resume agent_01h9 --reason 'Prompt fix verified'agents exposures suspend
Section titled “agents exposures suspend”Stop every channel on an agent from accepting traffic.
everruns agents exposures suspend [OPTIONS] [AGENT]| Flag | Description |
|---|---|
--agent <AGENT_ID> | Agent’s prefixed public identifier. |
Example:
# Stop an agent answering on its exposed surfaces without deleting iteverruns agents exposures suspend agent_01h9 --reason 'Pause while the prompt is fixed'agents health-checks get
Section titled “agents health-checks get”Get a single agent health check run with its results.
everruns agents health-checks get [OPTIONS] --agent-id <agent_id> --run-id <run_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
--run-id <RUN_ID> | Required. Health check run’s prefixed public identifier. |
Example:
# Read the results of one health check runeverruns agents health-checks get --agent-id agent_01h9 --run-id healthcheck_01h9agents health-checks list
Section titled “agents health-checks list”List recent health check runs for an agent.
everruns agents health-checks list [OPTIONS] --agent-id <agent_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
Example:
# Review recent health check runs and their outcomeseverruns agents health-checks list --agent-id agent_01h9agents health-checks trigger
Section titled “agents health-checks trigger”Run a behavioral health check (generated smoke tests) against an agent.
everruns agents health-checks trigger [OPTIONS] --agent-id <agent_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
Example:
# Smoke-test an agent's behavior after changing its prompteverruns agents health-checks trigger --agent-id agent_01h9 --reason 'Verify the prompt rewrite'agents health-checks latest get
Section titled “agents health-checks latest get”Get the latest health check run for an agent, with a stale-config flag.
everruns agents health-checks latest get [OPTIONS] --agent-id <agent_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Agent’s prefixed public identifier, or its name. |
Example:
# See the newest run and whether the agent changed since iteverruns agents health-checks latest get --agent-id agent_01h9agents scripts create
Section titled “agents scripts create”Create a saved shell script an agent owns.
everruns agents scripts create [OPTIONS] --agent-id <agent_id> --body <body> --description <description> --name <name>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--body <BODY> | Required. Shell script source, 1 to 65536 bytes. |
--description <DESCRIPTION> | Required. One-line description, 1 to 300 characters. |
--input-schema <INPUT_SCHEMA> | JSON Schema of the input; must be an object schema ("type": "object"). |
--name <NAME> | Required. Script name: lowercase letters, digits, _ and -, starting with a letter, at most 64 chara… |
Example:
# Save a reusable shell script on an agenteverruns agents scripts create --agent-id agent_01h9 --name run-tests --description 'Run the unit tests' --body 'cargo test --workspace' --reason 'Give the agent a one-step test runner'agents scripts delete
Section titled “agents scripts delete”Archive a saved script and free its name.
everruns agents scripts delete [OPTIONS] --agent-id <agent_id> --script-id <script_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--script-id <SCRIPT_ID> | Required. Saved script’s prefixed public identifier. |
Example:
# Archive a script the agent no longer needs and free its nameeverruns agents scripts delete --agent-id agent_01h9 --script-id scr_01h9 --reason 'Replaced by run-tests'agents scripts get
Section titled “agents scripts get”Get a single saved script by id.
everruns agents scripts get [OPTIONS] --agent-id <agent_id> --script-id <script_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--script-id <SCRIPT_ID> | Required. Saved script’s prefixed public identifier. |
Example:
# Read a script's body before editing or running iteverruns agents scripts get --agent-id agent_01h9 --script-id scr_01h9agents scripts list
Section titled “agents scripts list”List an agent’s saved scripts with their bodies. include_archived=true also returns archived.
everruns agents scripts list [OPTIONS] [AGENT_ID]| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Owning agent’s prefixed public identifier. |
--include-archived | Also return archived scripts. |
Example:
# See which scripts an agent already has before adding anothereverruns agents scripts list agent_01h9agents scripts update
Section titled “agents scripts update”Update a saved script’s description, input schema or body. The name is immutable.
everruns agents scripts update [OPTIONS] --agent-id <agent_id> --script-id <script_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--body <BODY> | Replacement script source. |
--description <DESCRIPTION> | Replacement description. |
--input-schema <INPUT_SCHEMA> | Replacement input schema (an object schema). |
--script-id <SCRIPT_ID> | Required. Saved script’s prefixed public identifier. |
Example:
# Change a script's body, keeping its nameeverruns agents scripts update --agent-id agent_01h9 --script-id scr_01h9 --body 'cargo test --workspace --locked' --reason 'Pin tests to the lockfile'agents triggers create
Section titled “agents triggers create”Create a schedule or webhook trigger for an agent.
everruns agents triggers create [OPTIONS] --agent-id <agent_id> --message <message>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--auth <AUTH> | Shared endpoint auth is not supported by webhook triggers. |
--cron-expression <CRON_EXPRESSION> | Cron expression that drives the durable schedule. |
--enabled | Whether the trigger is active on creation (default true). |
--event-id-template <EVENT_ID_TEMPLATE> | Webhook only: template for the delivery idempotency key. |
--filter <FILTER> | |
--github-events <GITHUB_EVENTS> | GitHub only: subscribed events (pull_request or pull_request.opened). Repeatable. |
--mcp-event <MCP_EVENT> | MCP event only: event name from the server’s events/list. |
--mcp-event-arguments <MCP_EVENT_ARGUMENTS> | MCP event only: subscription arguments object (the event’s inputSchema). |
--mcp-server <MCP_SERVER> | MCP event only: name of the agent’s MCP server attachment to subscribe to. |
--message <MESSAGE> | Required. Message content or {{template}} sent when the trigger fires. |
--rate-limit-per-minute <RATE_LIMIT_PER_MINUTE> | Optional per-ingress, per-IP webhook request limit. |
--repositories <REPOSITORIES> | GitHub only: repositories (owner/name) to accept; empty accepts all. Repeatable. |
--script <SCRIPT> | |
--session-mode <SESSION_MODE> | What identity keys a session, for every exposure and every transport. One enum replaces the … One of per_thread, per_channel, per_user, shared_session, session_per_invocation. |
--subject-template <SUBJECT_TEMPLATE> | Webhook and MCP event: template for the event subject. |
--timezone <TIMEZONE> | IANA timezone identifier for cron evaluation (default UTC). |
--token <TOKEN> | Shared secret for webhook triggers. |
--trigger-type <TRIGGER_TYPE> | The kind of event that fires an agent trigger. One of schedule, webhook, github, mcp_event. |
Example:
# Run an agent every weekday morning on a cron scheduleeverruns agents triggers create --agent-id agent_01h9 --trigger-type schedule --cron-expression '0 9 * * 1-5' --message 'Summarize overnight alerts' --reason 'Daily alert digest'agents triggers delete
Section titled “agents triggers delete”Archive an agent trigger and remove its durable schedule.
everruns agents triggers delete [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--trigger-id <TRIGGER_ID> | Required. Agent trigger’s prefixed public identifier. |
Example:
# Stop a trigger from firing and archive iteverruns agents triggers delete --agent-id agent_01h9 --trigger-id trg_01h9 --reason 'Digest no longer needed'agents triggers get
Section titled “agents triggers get”Get a single agent trigger by id.
everruns agents triggers get [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--trigger-id <TRIGGER_ID> | Required. Agent trigger’s prefixed public identifier. |
Example:
# Check a trigger's type, schedule and enabled stateeverruns agents triggers get --agent-id agent_01h9 --trigger-id trg_01h9agents triggers list
Section titled “agents triggers list”List an agent’s triggers. include_archived=true also returns archived.
everruns agents triggers list [OPTIONS] [AGENT_ID]| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Owning agent’s prefixed public identifier. |
--include-archived | Also return archived items. |
Example:
# See what triggers an agent already has before adding oneeverruns agents triggers list agent_01h9agents triggers trigger
Section titled “agents triggers trigger”Manually fire an agent trigger once.
everruns agents triggers trigger [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--trigger-id <TRIGGER_ID> | Required. Agent trigger’s prefixed public identifier. |
Example:
# Fire a trigger once now to test it without waiting for its scheduleeverruns agents triggers trigger --agent-id agent_01h9 --trigger-id trg_01h9 --reason 'Test the digest message'agents triggers update
Section titled “agents triggers update”Update an agent trigger. Only provided fields change.
everruns agents triggers update [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--auth <AUTH> | Shared endpoint auth is not supported by webhook triggers. |
--cron-expression <CRON_EXPRESSION> | Replacement cron expression. |
--enabled | Replacement enabled state. |
--event-id-template <EVENT_ID_TEMPLATE> | Replacement idempotency-key template. |
--filter <FILTER> | |
--github-events <GITHUB_EVENTS> | Replacement GitHub event subscriptions. Repeatable. |
--mcp-event <MCP_EVENT> | Replacement MCP event name. |
--mcp-event-arguments <MCP_EVENT_ARGUMENTS> | Replacement MCP event subscription arguments. |
--mcp-server <MCP_SERVER> | Replacement MCP server attachment name. |
--message <MESSAGE> | Replacement message sent when the trigger fires. |
--rate-limit-per-minute <RATE_LIMIT_PER_MINUTE> | Replacement per-ingress, per-IP webhook request limit. |
--repositories <REPOSITORIES> | Replacement GitHub repository scope. Repeatable. |
--script <SCRIPT> | |
--session-mode <SESSION_MODE> | |
--subject-template <SUBJECT_TEMPLATE> | Replacement subject template. |
--timezone <TIMEZONE> | Replacement IANA timezone identifier. |
--token <TOKEN> | Replacement webhook token. |
--trigger-id <TRIGGER_ID> | Required. Agent trigger’s prefixed public identifier. |
Example:
# Pause a trigger without deleting iteverruns agents triggers update --agent-id agent_01h9 --trigger-id trg_01h9 --enabled false --reason 'Pause during the migration'agents triggers deliveries list
Section titled “agents triggers deliveries list”List recent events delivered to an agent trigger: dispatched, filtered, duplicate or failed.
everruns agents triggers deliveries list [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--limit <LIMIT> | Maximum rows to return (1-200, default 50). |
--trigger-id <TRIGGER_ID> | Required. Agent trigger’s prefixed public identifier. |
Example:
# Find out why a webhook or event trigger did not start a sessioneverruns agents triggers deliveries list --agent-id agent_01h9 --trigger-id trg_01h9 --limit 20agents triggers runs list
Section titled “agents triggers runs list”List recent execution outcomes for an agent trigger.
everruns agents triggers runs list [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>| Flag | Description |
|---|---|
--agent-id <AGENT_ID> | Required. Owning agent’s prefixed public identifier. |
--trigger-id <TRIGGER_ID> | Required. Agent trigger’s prefixed public identifier. |
Example:
# See whether recent firings of a trigger succeededeverruns agents triggers runs list --agent-id agent_01h9 --trigger-id trg_01h9