Skip to content
Everruns Cloud is open in early access. Run agents without operating the platform.

Agent definitions and their configuration.

CommandWhat it does
agents importImport a portable agent file, folder or ZIP.
agents exportExport an agent by name without IDs or credentials.
agents validateValidate a package locally, or also check destination dependencies.
agents diffGenerate a semantic diff against a local package or a remote agent.
agents createCreate a new agent (upserts if id: is present in frontmatter)
agents updateUpdate an existing agent from a file definition.
agents analyzeRun advisory checks (built-in rules plus LLM analysis) against an agent configuration.
agents check-nameCheck whether an agent name is available.
agents copyCopy an agent.
agents deleteArchive an agent (soft delete).
agents destroyPermanently delete an archived agent.
agents draftRevise an agent draft from a conversation with the agent builder.
agents getGet a single agent by ID or name.
agents listList all active agents.
agents previewPreview the final agent shape with capabilities applied.
agents upsertUpsert agent — create (201) or update (200) by ID.
agents channels createCreate an ingress channel for an agent.
agents channels deleteDelete an agent ingress channel.
agents channels getGet an agent ingress channel.
agents channels listList an agent’s ingress channels.
agents channels publishPublish an agent ingress channel.
agents channels triggerRun an agent schedule channel now.
agents channels unpublishUnpublish an agent ingress channel.
agents channels updateUpdate an agent ingress channel.
agents channels keys createCreate an agent key for an agent’s API channel.
agents channels keys listList the agent keys of an agent’s API channel.
agents channels keys revokeRevoke an agent key.
agents channels keys rotateReplace an agent key’s secret, keeping its id.
agents check-rules deleteDelete an agent check rule (built-in override or custom rule).
agents check-rules listList the org’s agent check rules: built-in rules with their effective enabled/severity, plus custom rules.
agents check-rules upsertCreate or update an agent check rule (built-in override or custom rule).
agents credentials createCreate a write-only Agent credential setup requirement for one attached MCP tool parameter.
agents exposures resumeLet an agent’s live channels accept traffic again.
agents exposures suspendStop every channel on an agent from accepting traffic.
agents health-checks getGet a single agent health check run with its results.
agents health-checks listList recent health check runs for an agent.
agents health-checks triggerRun a behavioral health check (generated smoke tests) against an agent.
agents health-checks latest getGet the latest health check run for an agent, with a stale-config flag.
agents scripts createCreate a saved shell script an agent owns.
agents scripts deleteArchive a saved script and free its name.
agents scripts getGet a single saved script by id.
agents scripts listList an agent’s saved scripts with their bodies.
agents scripts updateUpdate a saved script’s description, input schema or body.
agents triggers createCreate a schedule or webhook trigger for an agent.
agents triggers deleteArchive an agent trigger and remove its durable schedule.
agents triggers getGet a single agent trigger by id.
agents triggers listList an agent’s triggers.
agents triggers triggerManually fire an agent trigger once.
agents triggers updateUpdate an agent trigger.
agents triggers deliveries listList recent events delivered to an agent trigger: dispatched, filtered, duplicate or failed.
agents triggers runs listList recent execution outcomes for an agent trigger.

Import a portable agent file, folder or ZIP.

Terminal window
everruns agents import [OPTIONS] [PATH]
FlagDescription
<PATH>
--content <CONTENT>Inline definition (also supported by Platform Chat and MCP)
--target <TARGET>Explicit existing agent name to update.
--format <FORMAT>

Export an agent by name without IDs or credentials.

Terminal window
everruns agents export [OPTIONS] <AGENT>
FlagDescription
<AGENT>Required.
--format <FORMAT>One of markdown, toml, yaml, json, zip, folder.
--out <OUT>

Validate a package locally, or also check destination dependencies.

Terminal window
everruns agents validate [OPTIONS] <FILE>
FlagDescription
<FILE>Required.
--remote

Generate a semantic diff against a local package or a remote agent.

Terminal window
everruns agents diff [OPTIONS] <FILE>
FlagDescription
<FILE>Required.
--against <AGAINST>
--target <TARGET>

Create a new agent (upserts if id: is present in frontmatter)

Terminal window
everruns agents create [OPTIONS]
FlagDescription
-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)
--writableMake 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.

Update an existing agent from a file definition.

Terminal window
everruns agents update [OPTIONS] [AGENT_ID]
FlagDescription
<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)
--writableMake 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.

Run advisory checks (built-in rules plus LLM analysis) against an agent configuration.

Terminal window
everruns agents analyze [OPTIONS]
FlagDescription
--capabilities <CAPABILITIES>
--harness-id <HARNESS_ID>
--initial-files <INITIAL_FILES>
--mcp-servers <MCP_SERVERS>
--system-prompt <SYSTEM_PROMPT>
--tools <TOOLS>

Example:

Terminal window
# Check a draft configuration for problems before creating the agent
everruns agents analyze --system-prompt 'Triage incoming issues' --tools '["bash"]'

Check whether an agent name is available.

Terminal window
everruns agents check-name [OPTIONS] --name <name>
FlagDescription
--exclude-id <EXCLUDE_ID>
--name <NAME>Required. Human-readable name.

Example:

Terminal window
# See whether a name is free before creating an agent
everruns agents check-name --name triage

Copy an agent. Generates a unique name.

Terminal window
everruns agents copy [OPTIONS] [ID]
FlagDescription
--id <ID>Prefixed public identifier.

Example:

Terminal window
# Duplicate an agent to try a change without touching the original
everruns agents copy agent_01h9 --reason 'Trial a stricter prompt'

Archive an agent (soft delete). Can be restored.

Terminal window
everruns agents delete [OPTIONS] [ID]
FlagDescription
--id <ID>Prefixed public identifier.

Example:

Terminal window
# Archive an agent, keeping it restorable
everruns agents delete agent_01h9 --reason 'Replaced by triage-v2'

Permanently delete an archived agent.

Terminal window
everruns agents destroy [OPTIONS] [ID]
FlagDescription
--id <ID>Prefixed public identifier.

Example:

Terminal window
# Permanently remove an already-archived agent
everruns agents destroy agent_01h9 --reason 'Retired after the archive window'

Revise an agent draft from a conversation with the agent builder. Returns the draft only; nothing is created.

Terminal window
everruns agents draft [OPTIONS] --messages <messages>
FlagDescription
--draft <DRAFT>
--messages <MESSAGES>Required. Conversation so far, oldest first.

Example:

Terminal window
# Ask the builder for a first draft
everruns agents draft --messages '[{"role":"user","content":"Triage new GitHub issues every morning"}]'

Get a single agent by ID or name.

Terminal window
everruns agents get [OPTIONS] [ID]
FlagDescription
--id <ID>Prefixed public identifier.

Example:

Terminal window
# Show one agent's full configuration
everruns agents get agent_01h9

List all active agents. Use search for name search, include_archived=true to include archived. Supports pagination (limit/offset).

Terminal window
everruns agents list [OPTIONS]
FlagDescription
--include-archived
--limit <LIMIT>Maximum number of items returned in this page.
--offset <OFFSET>Zero-based offset into the result set.
--search <SEARCH>

Example:

Terminal window
# Find agents by name when you do not know the id
everruns agents list --search triage --limit 20

Preview the final agent shape with capabilities applied.

Terminal window
everruns agents preview [OPTIONS]
FlagDescription
--capabilities <CAPABILITIES>
--harness-id <HARNESS_ID>
--initial-files <INITIAL_FILES>
--mcp-servers <MCP_SERVERS>
--system-prompt <SYSTEM_PROMPT>
--tools <TOOLS>

Example:

Terminal window
# See the prompt a draft configuration would produce, without creating it
everruns agents preview --system-prompt 'Triage incoming issues'

Upsert agent — create (201) or update (200) by ID.

Terminal window
everruns agents upsert [OPTIONS] --name <name> --system-prompt <system_prompt> [ID]
FlagDescription
--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-callsRequest-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:

Terminal window
# Create or replace an agent at a known id, for a scripted deploy
everruns agents upsert agent_01h9 --name triage --system-prompt 'Triage incoming issues' --reason 'Deploy release 42'

Create an ingress channel for an agent.

Terminal window
everruns agents channels create [OPTIONS] --agent-id <agent_id> --channel-type <channel_type>
FlagDescription
--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.
--enabledWhether the channel can accept ingress traffic.

Example:

Terminal window
# Add a weekday-morning schedule that starts the agent on its own
everruns 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'

Delete an agent ingress channel.

Terminal window
everruns agents channels delete [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>
FlagDescription
--agent-id <AGENT_ID>Required. Agent’s prefixed public identifier, or its name.
--channel-id <CHANNEL_ID>Required. Channel’s prefixed public identifier.

Example:

Terminal window
# Remove a channel the agent should no longer be reachable through
everruns agents channels delete --agent-id agent_01h9 --channel-id appchan_01h9 --reason 'Schedule replaced by a webhook'

Get an agent ingress channel.

Terminal window
everruns agents channels get [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>
FlagDescription
--agent-id <AGENT_ID>Required. Agent’s prefixed public identifier, or its name.
--channel-id <CHANNEL_ID>Required. Channel’s prefixed public identifier.

Example:

Terminal window
# Inspect one channel's configuration and whether it is live
everruns agents channels get --agent-id agent_01h9 --channel-id appchan_01h9

List an agent’s ingress channels.

Terminal window
everruns agents channels list [OPTIONS] --agent-id <agent_id>
FlagDescription
--agent-id <AGENT_ID>Required. Agent’s prefixed public identifier, or its name.

Example:

Terminal window
# See every way an agent can be reached before adding another
everruns agents channels list --agent-id agent_01h9

Publish an agent ingress channel.

Terminal window
everruns agents channels publish [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>
FlagDescription
--agent-id <AGENT_ID>Required. Agent’s prefixed public identifier, or its name.
--channel-id <CHANNEL_ID>Required. Channel’s prefixed public identifier.

Example:

Terminal window
# Make a reviewed channel live so it accepts traffic
everruns agents channels publish --agent-id agent_01h9 --channel-id appchan_01h9 --reason 'Config reviewed'

Run an agent schedule channel now.

Terminal window
everruns agents channels trigger [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>
FlagDescription
--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:

Terminal window
# Run a schedule channel now instead of waiting for its next fire time
everruns agents channels trigger --agent-id agent_01h9 --channel-id appchan_01h9 --reason 'Check the digest before the first scheduled run'

Unpublish an agent ingress channel.

Terminal window
everruns agents channels unpublish [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>
FlagDescription
--agent-id <AGENT_ID>Required. Agent’s prefixed public identifier, or its name.
--channel-id <CHANNEL_ID>Required. Channel’s prefixed public identifier.

Example:

Terminal window
# Take a channel offline without deleting its configuration
everruns agents channels unpublish --agent-id agent_01h9 --channel-id appchan_01h9 --reason 'Pause while the integration is reworked'

Update an agent ingress channel.

Terminal window
everruns agents channels update [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>
FlagDescription
--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.
--enabledWhether the channel can accept ingress traffic.

Example:

Terminal window
# Pause a channel without deleting it
everruns agents channels update --agent-id agent_01h9 --channel-id appchan_01h9 --enabled false --reason 'Pause during the migration'

Create an agent key for an agent’s API channel. The secret is returned once.

Terminal window
everruns agents channels keys create [OPTIONS] --agent-id <agent_id> --channel-id <channel_id> --name <name>
FlagDescription
--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:

Terminal window
# Give a backend service its own key to call the agent
everruns agents channels keys create --agent-id agent_01h9 --channel-id appchan_01h9 --name "Support backend" --reason "New support integration"

List the agent keys of an agent’s API channel. Secrets are never returned.

Terminal window
everruns agents channels keys list [OPTIONS] --agent-id <agent_id> --channel-id <channel_id>
FlagDescription
--agent-id <AGENT_ID>Required.
--channel-id <CHANNEL_ID>Required.

Example:

Terminal window
# See which applications hold a key before rotating or revoking one
everruns agents channels keys list --agent-id agent_01h9 --channel-id appchan_01h9

Revoke an agent key. It never works again, including a secret still in its rotation overlap.

Terminal window
everruns agents channels keys revoke [OPTIONS] --agent-id <agent_id> --channel-id <channel_id> --key-id <key_id>
FlagDescription
--agent-id <AGENT_ID>Required.
--channel-id <CHANNEL_ID>Required.
--key-id <KEY_ID>Required.

Example:

Terminal window
# Cut off a key that leaked, immediately
everruns agents channels keys revoke --agent-id agent_01h9 --channel-id appchan_01h9 --key-id agentkey_01h9 --reason "Key exposed in a log"

Replace an agent key’s secret, keeping its id. The new secret is returned once; the old one works for the overlap.

Terminal window
everruns agents channels keys rotate [OPTIONS] --agent-id <agent_id> --channel-id <channel_id> --key-id <key_id>
FlagDescription
--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:

Terminal window
# Replace a key secret on schedule, keeping the old one valid for a day
everruns agents channels keys rotate --agent-id agent_01h9 --channel-id appchan_01h9 --key-id agentkey_01h9 --overlap-hours 24 --reason "Quarterly rotation"

Delete an agent check rule (built-in override or custom rule).

Terminal window
everruns agents check-rules delete [OPTIONS] --rule-id <rule_id>
FlagDescription
--rule-id <RULE_ID>Required. Rule id to delete: a built-in rule id (clears its override) or custom.<slug>.

Example:

Terminal window
# Drop a custom check rule that no longer applies
everruns agents check-rules delete --rule-id custom.no-pii --reason 'Covered by the org policy'

List the org’s agent check rules: built-in rules with their effective enabled/severity, plus custom rules.

Terminal window
everruns agents check-rules list [OPTIONS]

Example:

Terminal window
# See which built-in and custom rules apply before changing one
everruns agents check-rules list

Create or update an agent check rule (built-in override or custom rule).

Terminal window
everruns agents check-rules upsert [OPTIONS] --enabled [<enabled>] --kind <kind> --rule-id <rule_id>
FlagDescription
--category <CATEGORY>Finding category for custom rules: structure, completeness, effectiveness, safety, or…
--enabledRequired. 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:

Terminal window
# Add an LLM-judged rule that flags prompts handling personal data
everruns 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'

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.

Terminal window
everruns agents credentials create [OPTIONS] --label <label> --mcp-server-name <mcp_server_name> --parameter-name <parameter_name> --tool-name <tool_name>
FlagDescription
--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:

Terminal window
# Declare that an MCP tool needs a secret the model must never see
everruns 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'

Let an agent’s live channels accept traffic again.

Terminal window
everruns agents exposures resume [OPTIONS] [AGENT]
FlagDescription
--agent <AGENT_ID>Agent’s prefixed public identifier.

Example:

Terminal window
# Put a suspended agent back on its exposed surfaces
everruns agents exposures resume agent_01h9 --reason 'Prompt fix verified'

Stop every channel on an agent from accepting traffic.

Terminal window
everruns agents exposures suspend [OPTIONS] [AGENT]
FlagDescription
--agent <AGENT_ID>Agent’s prefixed public identifier.

Example:

Terminal window
# Stop an agent answering on its exposed surfaces without deleting it
everruns agents exposures suspend agent_01h9 --reason 'Pause while the prompt is fixed'

Get a single agent health check run with its results.

Terminal window
everruns agents health-checks get [OPTIONS] --agent-id <agent_id> --run-id <run_id>
FlagDescription
--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:

Terminal window
# Read the results of one health check run
everruns agents health-checks get --agent-id agent_01h9 --run-id healthcheck_01h9

List recent health check runs for an agent.

Terminal window
everruns agents health-checks list [OPTIONS] --agent-id <agent_id>
FlagDescription
--agent-id <AGENT_ID>Required. Agent’s prefixed public identifier, or its name.

Example:

Terminal window
# Review recent health check runs and their outcomes
everruns agents health-checks list --agent-id agent_01h9

Run a behavioral health check (generated smoke tests) against an agent.

Terminal window
everruns agents health-checks trigger [OPTIONS] --agent-id <agent_id>
FlagDescription
--agent-id <AGENT_ID>Required. Agent’s prefixed public identifier, or its name.

Example:

Terminal window
# Smoke-test an agent's behavior after changing its prompt
everruns agents health-checks trigger --agent-id agent_01h9 --reason 'Verify the prompt rewrite'

Get the latest health check run for an agent, with a stale-config flag.

Terminal window
everruns agents health-checks latest get [OPTIONS] --agent-id <agent_id>
FlagDescription
--agent-id <AGENT_ID>Required. Agent’s prefixed public identifier, or its name.

Example:

Terminal window
# See the newest run and whether the agent changed since it
everruns agents health-checks latest get --agent-id agent_01h9

Create a saved shell script an agent owns.

Terminal window
everruns agents scripts create [OPTIONS] --agent-id <agent_id> --body <body> --description <description> --name <name>
FlagDescription
--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:

Terminal window
# Save a reusable shell script on an agent
everruns 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'

Archive a saved script and free its name.

Terminal window
everruns agents scripts delete [OPTIONS] --agent-id <agent_id> --script-id <script_id>
FlagDescription
--agent-id <AGENT_ID>Required. Owning agent’s prefixed public identifier.
--script-id <SCRIPT_ID>Required. Saved script’s prefixed public identifier.

Example:

Terminal window
# Archive a script the agent no longer needs and free its name
everruns agents scripts delete --agent-id agent_01h9 --script-id scr_01h9 --reason 'Replaced by run-tests'

Get a single saved script by id.

Terminal window
everruns agents scripts get [OPTIONS] --agent-id <agent_id> --script-id <script_id>
FlagDescription
--agent-id <AGENT_ID>Required. Owning agent’s prefixed public identifier.
--script-id <SCRIPT_ID>Required. Saved script’s prefixed public identifier.

Example:

Terminal window
# Read a script's body before editing or running it
everruns agents scripts get --agent-id agent_01h9 --script-id scr_01h9

List an agent’s saved scripts with their bodies. include_archived=true also returns archived.

Terminal window
everruns agents scripts list [OPTIONS] [AGENT_ID]
FlagDescription
--agent-id <AGENT_ID>Owning agent’s prefixed public identifier.
--include-archivedAlso return archived scripts.

Example:

Terminal window
# See which scripts an agent already has before adding another
everruns agents scripts list agent_01h9

Update a saved script’s description, input schema or body. The name is immutable.

Terminal window
everruns agents scripts update [OPTIONS] --agent-id <agent_id> --script-id <script_id>
FlagDescription
--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:

Terminal window
# Change a script's body, keeping its name
everruns agents scripts update --agent-id agent_01h9 --script-id scr_01h9 --body 'cargo test --workspace --locked' --reason 'Pin tests to the lockfile'

Create a schedule or webhook trigger for an agent.

Terminal window
everruns agents triggers create [OPTIONS] --agent-id <agent_id> --message <message>
FlagDescription
--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.
--enabledWhether 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:

Terminal window
# Run an agent every weekday morning on a cron schedule
everruns agents triggers create --agent-id agent_01h9 --trigger-type schedule --cron-expression '0 9 * * 1-5' --message 'Summarize overnight alerts' --reason 'Daily alert digest'

Archive an agent trigger and remove its durable schedule.

Terminal window
everruns agents triggers delete [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>
FlagDescription
--agent-id <AGENT_ID>Required. Owning agent’s prefixed public identifier.
--trigger-id <TRIGGER_ID>Required. Agent trigger’s prefixed public identifier.

Example:

Terminal window
# Stop a trigger from firing and archive it
everruns agents triggers delete --agent-id agent_01h9 --trigger-id trg_01h9 --reason 'Digest no longer needed'

Get a single agent trigger by id.

Terminal window
everruns agents triggers get [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>
FlagDescription
--agent-id <AGENT_ID>Required. Owning agent’s prefixed public identifier.
--trigger-id <TRIGGER_ID>Required. Agent trigger’s prefixed public identifier.

Example:

Terminal window
# Check a trigger's type, schedule and enabled state
everruns agents triggers get --agent-id agent_01h9 --trigger-id trg_01h9

List an agent’s triggers. include_archived=true also returns archived.

Terminal window
everruns agents triggers list [OPTIONS] [AGENT_ID]
FlagDescription
--agent-id <AGENT_ID>Owning agent’s prefixed public identifier.
--include-archivedAlso return archived items.

Example:

Terminal window
# See what triggers an agent already has before adding one
everruns agents triggers list agent_01h9

Manually fire an agent trigger once.

Terminal window
everruns agents triggers trigger [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>
FlagDescription
--agent-id <AGENT_ID>Required. Owning agent’s prefixed public identifier.
--trigger-id <TRIGGER_ID>Required. Agent trigger’s prefixed public identifier.

Example:

Terminal window
# Fire a trigger once now to test it without waiting for its schedule
everruns agents triggers trigger --agent-id agent_01h9 --trigger-id trg_01h9 --reason 'Test the digest message'

Update an agent trigger. Only provided fields change.

Terminal window
everruns agents triggers update [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>
FlagDescription
--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.
--enabledReplacement 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:

Terminal window
# Pause a trigger without deleting it
everruns agents triggers update --agent-id agent_01h9 --trigger-id trg_01h9 --enabled false --reason 'Pause during the migration'

List recent events delivered to an agent trigger: dispatched, filtered, duplicate or failed.

Terminal window
everruns agents triggers deliveries list [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>
FlagDescription
--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:

Terminal window
# Find out why a webhook or event trigger did not start a session
everruns agents triggers deliveries list --agent-id agent_01h9 --trigger-id trg_01h9 --limit 20

List recent execution outcomes for an agent trigger.

Terminal window
everruns agents triggers runs list [OPTIONS] --agent-id <agent_id> --trigger-id <trigger_id>
FlagDescription
--agent-id <AGENT_ID>Required. Owning agent’s prefixed public identifier.
--trigger-id <TRIGGER_ID>Required. Agent trigger’s prefixed public identifier.

Example:

Terminal window
# See whether recent firings of a trigger succeeded
everruns agents triggers runs list --agent-id agent_01h9 --trigger-id trg_01h9