# Automate.ax

> Install or read the main skill before working with Automate.ax.

## Main skill

- **Required guidance:** [Read the main Automate.ax skill](https://docs.automate.ax/.well-known/agent-skills/automate-ax/SKILL.md) — setup, signal composition, testing, authorization, deployment, proof, debugging, and cleanup.

```bash
bunx skills add SentsCo/automate-ax-agent-plugins --skill automate-ax --yes
```

## Other skills

### Share an automation

- [Share an Automate.ax automation](https://docs.automate.ax/.well-known/agent-skills/share-automate-ax-automation/SKILL.md) — package an automation as a reusable repository without copying project identity, credentials, bindings, or deployment state.

```bash
bunx skills add SentsCo/automate-ax-agent-plugins --skill share-automate-ax-automation --yes
```

## Command-line cheat sheet

```bash
bunx automate.ax --help
bunx automate.ax <command> --help
```

### Start a project

```bash
bunx automate.ax me --json
bunx automate.ax login
bunx automate.ax project create --help
bunx automate.ax init --project <project-id> --json
```

### Accounts and deployment

```bash
bunx automate.ax accounts --help
bunx automate.ax deploy --help
bunx automate.ax deploy --cli-authorization
bunx automate.ax deployment authorize <deployment-id> --no-open
bunx automate.ax deployment list --project <project-id> --json
bunx automate.ax deployment show <deployment-id> --json
```

### Automations and runs

```bash
bunx automate.ax automation list --project <project-id> --json
bunx automate.ax automation show --automation <automation-id> --json
bunx automate.ax data sync --project <project-id> --since 1h
bunx automate.ax data schema
bunx automate.ax query --help
bunx automate.ax search <text-or-id> --json
```

### Administration

```bash
bunx automate.ax org --help
bunx automate.ax project --help
bunx automate.ax invite --help
bunx automate.ax upgrade --help
bunx automate.ax debug --help
```

## Start

- [Start with a coding agent](https://docs.automate.ax/start/with-agent.md) — what the agent handles and where browser authorization appears.
- [Start manually](https://docs.automate.ax/start/manually.md) — create, write, deploy, and invoke an HTTP automation yourself.

## Concepts

- [Automations](https://docs.automate.ax/concepts/automations.md) — project files, synchronous composition, deployment snapshots, and runs.
- [Triggers](https://docs.automate.ax/concepts/triggers.md) — static configuration, subscriptions, duplicate deliveries, callbacks, and HTTP responses.
- [Actions](https://docs.automate.ax/concepts/actions.md) — inputs, outputs, activation boundaries, ordering, failures, retries, and accounts.
- [Signals](https://docs.automate.ax/concepts/signals.md) — planning, dependencies, contexts, partitions, closure, and failure.
- [Integration accounts](https://docs.automate.ax/concepts/integration-accounts.md) — default and named bindings, scopes, connection methods, disconnect, and revoke.
- [Deployments and runs](https://docs.automate.ax/concepts/deployments-and-runs.md) — project snapshots, durable execution, retries, retention, and in-flight work.
- [Platform resources](https://docs.automate.ax/concepts/platform-resources.md) — metered AI and email usage.
- [Bun runtime](https://docs.automate.ax/concepts/bun-runtime.md) — runtime version, packages, compatibility, images, and handler lifetime.

## Guides

- [Deploy a project](https://docs.automate.ax/guides/deploy-a-project.md) — publish project code and assign integration accounts.
- [Use multiple accounts from the same service](https://docs.automate.ax/guides/use-multiple-accounts.md) — named account bindings and identity consistency.
- [Protect sensitive values](https://docs.automate.ax/guides/protect-sensitive-values.md) — sensitive action results, outputs, and logs.
- [Call an external API](https://docs.automate.ax/guides/call-an-external-api.md) — make durable HTTP requests and protect unsupported-service credentials.
- [Receive unsupported events](https://docs.automate.ax/guides/receive-unsupported-events.md) — HTTP webhooks and signature verification.
- [Derive signal values](https://docs.automate.ax/guides/derive-signal-values.md) — property access, transforms, and signal-aware strings.
- [Route signals and work](https://docs.automate.ax/guides/route-signals-and-work.md) — conditional values, prerequisites, branches, scopes, and groups.
- [Coordinate occurrences](https://docs.automate.ax/guides/coordinate-occurrences.md) — partitions, correlation, batching, and fan-out.
- [Control event bursts](https://docs.automate.ax/guides/control-event-bursts.md) — debouncing, windows, and custom funnel policies.
- [Select and time signals](https://docs.automate.ax/guides/select-and-time-signals.md) — races, delays, and deadlines.
- [Handle signal outcomes](https://docs.automate.ax/guides/handle-signal-outcomes.md) — success, failure, closure, and selective work.
- [Query runs](https://docs.automate.ax/guides/query-runs.md) — dashboard inspection, search, SQL, fan-out, outputs, and logs.

## Built-in triggers

- [On dashboard run](https://docs.automate.ax/reference/triggers/on-dashboard-run.md)
- [On HTTP request](https://docs.automate.ax/reference/triggers/on-http-request.md)
- [On invocation](https://docs.automate.ax/reference/triggers/on-invocation.md)
- [On mailhook](https://docs.automate.ax/reference/triggers/on-mailhook.md)
- [On schedule](https://docs.automate.ax/reference/triggers/on-schedule.md)

## Built-in actions

- [Fetch HTTP](https://docs.automate.ax/reference/actions/fetch-http.md)
- [Generate AI output](https://docs.automate.ax/reference/actions/generate.md)
- [Generate images](https://docs.automate.ax/reference/actions/generate-image.md)
- [Invoke an automation](https://docs.automate.ax/reference/actions/invoke-automation.md)
- [Send organization email](https://docs.automate.ax/reference/actions/send-email.md)
- [Respond to HTTP request](https://docs.automate.ax/reference/actions/respond-to-http-request.md)

## Signals and runtime

- [Reference directory](https://docs.automate.ax/_llms/reference.md) — every built-in trigger, built-in action, signal operator, runtime utility, and integration group.
- [Signal operators](https://docs.automate.ax/reference/runtime/signal-operators.md) — signatures, overload forms, options, defaults, public types, and errors.
- [Low-level utilities](https://docs.automate.ax/reference/runtime/low-level-utilities.md) — hook placement and active execution identity.

## Integrations

- [Integration reference directory](https://docs.automate.ax/_llms/reference/integrations.md) — every provider action and trigger page in one machine-readable index.

## REST API

- [OpenAPI specification](https://automate.ax/api/v1/openapi.json) — for managing Automate.ax resources: organizations, projects, integration accounts, deployments, automations, runs, and API keys.