Outcron Plain HTML

CLI Tool (outctl)

outctl is the command-line interface for managing Outcron organizations, jobs, schedules, executions, alerts, reports, billing, and account settings from your terminal.

Installation

Download the binary for your operating system from the CLI Tool page in the dashboard, or use curl:

curl -fSLo outctl https://dl.outcron.com/outctl-$(uname -s | tr A-Z a-z)-$(uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/')
    chmod +x outctl
    sudo mv outctl /usr/local/bin/
    

Authentication

outctl login                         # alias for `auth login`
    # Email: [email protected]
    # Password: ••••••••
    

Credentials are stored in ~/.config/outctl/config.json (override with OUTCTL_CONFIG_PATH).

Most commands are org-scoped. Select an org once with outctl orgs use and subsequent commands inherit it.

Organizations

outctl orgs list                     # List organizations you belong to
    outctl orgs get <id-or-slug>         # Get organization details
    outctl orgs update <id-or-slug>      # Update an organization
    outctl orgs use <id-or-slug>         # Set the default organization
    outctl orgs unuse                    # Clear the default organization
    

Command Reference

Jobs

outctl jobs list                    # List all jobs
    outctl jobs create                  # Create a job (interactive)
    outctl jobs get <job-id>            # Get job details
    outctl jobs update <job-id>         # Update a job
    outctl jobs trigger <job-id>        # Trigger a manual execution
    outctl jobs delete <job-id>         # Delete a job
    

Schedules

outctl schedules list               # List all schedules
    outctl schedules create             # Create a schedule
    outctl schedules get <id>           # Get schedule details
    outctl schedules update <id>        # Update a schedule
    outctl schedules preview            # Preview upcoming run times for a cron expression
    outctl schedules preview --cron '0 9 * * 1-5' --timezone America/Chicago --splay-sec 15
    outctl schedules preview <id>       # Preview upcoming run times for a saved schedule
    outctl schedules pause <id>         # Pause a schedule
    outctl schedules resume <id>        # Resume a schedule
    outctl schedules delete <id>        # Delete a schedule
    

Executions

outctl executions list              # List executions
    outctl executions get <id>          # Get execution details (result output max 1 MB)
    outctl executions forget            # Delete old completed execution history
    outctl executions forget --keep-90d --all
    outctl executions cancel <id>       # Cancel a pending execution
    

executions forget requires exactly one retention selector and one scope selector. --forget-all --all prompts for confirmation unless --yes is provided.

Dashboard

outctl dashboard health             # Get dashboard health and attention summary
    outctl dashboard upcoming           # List upcoming scheduled runs
    

Alerts

outctl alerts list                  # List alert rules
    outctl alerts create                # Create an alert rule
    outctl alerts get <id>              # Get alert rule details
    outctl alerts update <id>           # Update an alert rule
    outctl alerts delete <id>           # Delete an alert rule
    outctl alerts test <id>             # Emit a test rule.fired event
    outctl alerts subscriptions list    # List lifecycle event subscriptions
    outctl alerts subscriptions create  # Create a lifecycle event subscription
    outctl alerts subscriptions get <id>       # Get subscription details
    outctl alerts subscriptions update <id>    # Update a subscription
    outctl alerts subscriptions delete <id>    # Delete a subscription
    outctl alerts subscriptions test <id>      # Test a subscription
    outctl alerts events list           # List alert events
    outctl alerts events get <id>       # Get alert event details
    outctl alerts events ack <id>       # Acknowledge an alert event
    outctl alerts events unack <id>     # Clear an alert acknowledgement
    outctl alerts silences list         # List alert silences
    outctl alerts silences create       # Create a temporary silence
    outctl alerts silences delete <id>  # Delete a silence
    outctl alerts silences hits <id>    # List events suppressed by a silence
    outctl alerts escalation-policies list              # List escalation policies
    outctl alerts escalation-policies create            # Create an escalation policy
    outctl alerts escalation-policies get <id>          # Get escalation policy details
    outctl alerts escalation-policies update <id>       # Update an escalation policy
    outctl alerts escalation-policies delete <id>       # Delete an escalation policy
    

Reports

outctl reports list                 # List reports
    outctl reports templates            # List available report templates
    outctl reports create               # Create a report
    outctl reports get <id>             # Get report details
    outctl reports run <id>             # Run a report
    outctl reports update <id>          # Update a report
    outctl reports duplicate <id>       # Duplicate a report
    outctl reports delete <id>          # Delete a report
    outctl reports widget-preview       # Preview a report widget
    

Running or previewing report widgets requires both reports:read and the read permission for each widget dataset, such as executions:read, jobs:read, schedules:read, or users:read.

Exports

outctl exports create               # Create a table export request
    outctl exports get <id>             # Get export request status
    outctl exports download <id>        # Download a ready authenticated export
    outctl exports download-token <token-or-url>  # Download a one-time public export link
    

Support Tickets

outctl support tickets list                      # List support tickets
    outctl support tickets create                    # Create a ticket (supports file attachments)
    outctl support tickets get <id>                  # Get ticket details
    outctl support tickets update <id>               # Update a ticket
    outctl support tickets add-update <id>           # Add an update to a ticket
    outctl support tickets download <ticket-id> <attachment-id>  # Download an attachment
    

Access Control

outctl users list                   # List org users
    outctl users add                    # Add a user to the org
    outctl users get <id-or-email>      # Get user details
    outctl users update <id-or-email>   # Update a user's membership
    outctl users remove <id-or-email>   # Remove a user from the org
    outctl groups list                  # List groups
    outctl groups create                # Create a group
    outctl groups get <id>              # Get group details
    outctl groups update <id>           # Update a group
    outctl groups delete <id>           # Delete a group
    outctl roles list                   # List roles
    outctl roles create                 # Create a role
    outctl roles get <id>               # Get role details
    outctl roles update <id>            # Update a role
    outctl roles delete <id>            # Delete a role
    outctl roles permissions            # List available permissions
    outctl apikeys list                 # List API keys
    outctl apikeys create               # Create an API key
    outctl apikeys rotate <id>          # Rotate an API key secret
    outctl apikeys delete <id>          # Revoke an API key
    outctl apikeys permissions          # List available permissions
    

outctl users add uses invite mode by default. --mode attach-existing requires a platform-admin token; normal org admins should use the default invite flow.

Registries

outctl registries list              # List registry credentials
    outctl registries create            # Create a registry credential
    outctl registries get <id>          # Get registry credential details
    outctl registries update <id>       # Update a registry credential
    outctl registries delete <id>       # Delete a registry credential
    

Billing

outctl billing get                                    # Get billing summary
    outctl billing subscribe                              # Subscribe or change plan
    outctl billing cancel                                 # Schedule cancellation at period end
    outctl billing invoices list                          # List invoices
    outctl billing invoices get <id>                      # Get invoice details
    outctl billing subscription resume                    # Resume a canceled subscription
    outctl billing subscription preview-change            # Preview a plan change
    outctl billing subscription cancel-pending-downgrade  # Cancel a pending downgrade
    outctl billing address update                         # Update billing address
    outctl billing address update --country US --province TX --postal-code 75033
    

billing subscribe hands off to the browser for inline checkout when card or bank authentication is required.

Account

outctl auth login                        # Login and save credentials (also: `outctl login`)
    outctl auth logout                       # Clear saved credentials
    outctl auth refresh                      # Refresh the auth token with latest server data
    outctl auth whoami local                 # Show user info from the local token
    outctl auth whoami server                # Show user info from the server
    outctl auth permissions                  # List available permissions
    outctl auth permissions --json           # Print permissions as JSON
    outctl auth prefs get                    # View preferences
    outctl auth prefs update                 # Update preferences
    outctl auth email                        # Change email address
    outctl auth password                     # Change password
    outctl auth totp get                     # Show whether TOTP 2FA is enabled
    outctl auth totp enroll --current-password ... # Enable 2FA for password-backed accounts
    outctl auth totp disable                 # Disable 2FA
    outctl auth passkeys list                # List passkeys
    outctl auth passkeys delete <id>         # Delete a passkey
    

Audit Log

outctl audit-logs list              # List audit log entries
    outctl audit-logs get <id>          # Get entry details
    

Retention Policies

outctl retention                    # Show retention policies
    

Version / Self-Update

outctl version             # Print the version
    outctl selfupdate          # Download and install the latest version
    outctl selfupdate --check  # Only check whether an update is available
    

Self-update verifies signed release metadata, checks the downloaded binary's SHA-256, and replaces the running binary only after both checks pass.

Manual release verification:

binary=outctl-darwin-arm64
    curl -fsSLO "https://dl.outcron.com/${binary}"
    curl -fsSLO https://dl.outcron.com/outctl.sha256.txt
    curl -fsSLO https://dl.outcron.com/outctl.sha256.txt.minisig
    minisign -Vm outctl.sha256.txt -P RWQqZriq0xH1gv+H670Kg1SvhEWXkU+bVZXa+EW4wo1yVSyP2g20fvK5
    grep "  ${binary}$" outctl.sha256.txt | shasum -a 256 -c -
    

Platform-admin commands are intentionally not covered in these customer workflow docs.