Operator CLI · Alteryx One, Server & more

Drive Alteryx
from the command line.

ayx is a single, precise operator for Alteryx administration — a generated command surface, an explicit safety model, and structured output built for pipelines and agents.

$curl -fsSL https://raw.githubusercontent.com/RyanMerlin/ayx-rs/main/scripts/install.sh | bash
--apply

Read-only by default. Mutations are a deliberate act.

Run any mutating command and, without --apply, it prints a dry-run of exactly what would change and exits with status 0. Nothing touches remote state until you opt in. That is the whole point: safe to explore, safe to automate.

What ayx gives an operator

Generated command surface

The command reference is generated from the full, live command tree (`ayx catalog list --scope all`) and checked for staleness in CI — the docs follow the binary, not the other way around. For rich flag and tree discovery, run `ayx discover --deep`.

Explicit safety model

Commands are annotated read-only or mutating where curated; anything not yet classified is honestly marked unclassified, never guessed. Read-only needs no flags; mutating remote calls are gated behind --apply.

Dry-run by default

Run a mutating command without --apply and it prints exactly what would happen, then exits cleanly — safe to wire into automation.

Structured output

Pass --output json for machine-readable envelopes — built for pipelines, agents, and scripts, not just humans at a terminal.

Profiles & environments

A central profile store with per-run overrides and a multi-environment file shape, resolved through a documented precedence order.

Alteryx One, Server & more

One CLI across Alteryx One, Server, Designer, and more — administration, automation, and agentic workflows.

Three commands to first signal

1
Installcurl -fsSL https://raw.githubusercontent.com/RyanMerlin/ayx-rs/main/scripts/install.sh | bash
2
Onboardayx onboard
3
Checkayx doctor

Install drops the verified release binary on your PATH (you may need a new shell), then ayx onboard writes your first profile.