umbraco-automate

Files (1)

• SKILL.md

SKILL.md (first lines)

# automate

> **PREREQUISITE:** Read `../umbraco-shared/SKILL.md` for auth, global flags, and security rules.

```bash
umbraco automate <command> [flags]
```

## Overview

```text
Operate Umbraco Automate: discover the step catalogue, author and trigger automations, manage runs, decide approvals, and roll back via version history. Requires Umbraco Automate on the target instance; targets its Management API mount (/umbraco/automate/management/api/v1).
```

## Read Commands

| Command | Description |
|---------|-------------|
| `automate approvals pending` | List approvals waiting for a decision |
| `automate automation ancestors <id>` | Get an automation's location (workspace and group breadcrumb) |
| `automate automation export <id>` | Export an automation as a portable definition |
| `automate automation get <id>` | Get an automation by ID (trigger, steps, connections, state) |
| `automate automation list` | List automations (paginated; --skip/--take/--all) |
| `automate automation runs <id>` | List runs for an automation (paginated; --skip/--take/--all) |
| `automate automation validate --workspace-id <id> --file <export.json>` | Validate a new automation import server-side without writing anything |
| `automate catalogue actions` | List action step types |
| `automate catalogue connection-types` | List connection types |
| `automate catalogue control-flows` | List control-flow step types |
| `automate catalogue notification-channels` | List notification channels |
| `automate catalogue operators` | List condition/filter operators for automation export models |
| `automate catalogue output-schema <alias>` | Resolve a step type's dynamic output schema |
| `automate catalogue step-types` | List step types, optionally filtered by kind |
| `automate catalogue triggers` | List trigger step types |
| `automate catalogue webhook-authenticators` | List webhook authenticators |
| `automate connection get <id>` | Get a connection by ID |
| `automate connection list` | List connections (paginated; --skip/--take/--all) |
| `automate metrics by-automation` | Get run metrics grouped by automation |
| `automate metrics summary` | Get run summary metrics |
| `automate run get <id>` | Get a run by ID (per-step status, errors, retries, timing -- resolved step values are not exposed by the API) |
| `automate version-history compare <entity-type> <entity-id> <from-version> <to-version>` | Compare two stored versions of an entity |
| `automate version-history get <entity-type> <entity-id> <version>` | Get one stored version of an entity (the full payload as it was) |
| `automate version-history list <entity-type> <entity-id>` | List stored versions of an entity (paginated; --skip/--take) |
| `automate version-history types` | List the entity types that keep version history |
| `automate workspace get <id>` | Get a workspace by ID |
| `automate workspace group get <workspace-id> <group-id>` | Get an automation group |
| `automate workspace group list <workspace-id>` | List automation groups in a workspace |
| `automate workspace list` | List workspaces (paginated; --skip/--take/--all) |

### approvals pending

```bash
umbraco automate approvals pending
```

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |

### automation ancestors

```bash
umbraco automate automation ancestors <id>
```

### automation export

```bash
umbraco automate automation export <id>
```

GET /automations/{id}/export. The export model is the template format for 'automation validate', 'automation import', and 'automation import-update'. Filter conditions use string operators such as "NotEquals" in the lowercase operator field; Deploy .uda files use integer Operator values, so do not paste .uda condition JSON directly into import/update payloads. Use 'automate catalogue operators' for the mapping.

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--include` | string | — | Export include option |

### automation get

```bash
umbraco automate automation get <id>
```

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |

### automation list

```bash
umbraco automate automation list
```

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--all` | bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |
| `--filter` | string | — | Text filter |
| `--first-n` | int | 0 | Return only the first N items from item collections |
| `--group-id` | string | — | Group ID |
| `--ids-only` | bool | false | Return only item IDs for item collections |
| `--params` | string | — | Query parameters as JSON |
| `--skip` | int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
| `--summarize` | bool | false | Return only id/name/alias fields for item collections |
| `--take` | int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
| `--workspace-id` | string | — | Workspace ID |

### automation runs

```bash
umbraco automate automation runs <id>
```

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--all` | bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |
| `--first-n` | int | 0 | Return only the first N items from item collections |
| `--ids-only` | bool | false | Return only item IDs for item collections |
| `--params` | string | — | Query parameters as JSON |

From albanistrefi/umbraco_CLI, MIT.

More from albanistrefi/umbraco_CLI