Getting started

ayx is a single binary. Install it, run the setup wizard, and you’re connected to your Alteryx One workspace in a couple of minutes.

Install

macOS / Linux

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

Windows (PowerShell)

iwr https://raw.githubusercontent.com/RyanMerlin/ayx-rs/main/scripts/install.ps1 | iex

The installer downloads the latest release, verifies its SHA-256 checksum, and puts the ayx binary on your PATH. On macOS and Linux it adds the install directory to ~/.profile, so open a new terminal (or run the export PATH=… line it prints) before your first command.

macOS Gatekeeper: release binaries aren’t signed or notarized yet, so Gatekeeper will refuse to run the downloaded binary with something like “cannot be opened because the developer cannot be verified” or “is damaged and can’t be opened”. Clear the quarantine attribute to run it:

xattr -d com.apple.quarantine <path-to-binary-or-archive>

If you extracted a directory instead, add -r to clear it recursively:

xattr -dr com.apple.quarantine <path-to-directory>

Signing and notarization are planned.

Confirm it’s installed:

ayx --version

Connect

Run the setup wizard:

ayx onboard

It asks for two things:

Your email — the account you sign in to Alteryx One with.
Your workspace URL — paste it straight from your browser’s address bar while you’re in the workspace, e.g. https://us1.alteryxcloud.com/auth-portal/workspaces/01ABC…. ayx reads your workspace id and region out of it. (You can also paste just the id, or leave it blank and add it later.)

The wizard saves this as a profile — your named, reusable connection — and makes it active. It then offers to log you in right away:

Ready to connect. A one-time passcode will be emailed to you@example.com,
and you'll be asked for your workspace password.
Log in now [y/N]:

Answer y and you’ll be prompted for the 6-digit passcode emailed to you and your workspace password. ayx completes the sign-in and stores a 30-day token in your profile. (Prefer to do it later? Answer n — the wizard prints the exact command to run when you’re ready.)

You won’t need another passcode until the stored token expires (about 30 days); it’s reused for every command in between.

Verify

Check the whole path — config, auth, and connectivity — without changing anything on the server:

ayx doctor

Then confirm who you are and which workspace you’re pointed at:

ayx whoami

Want machine-readable output? Ask for JSON. --output is a global flag — it can appear anywhere on the command line, before or after the subcommand.

ayx --output json one workspace current

Where to go next

Connecting to Alteryx One — the login flows in detail, and connecting Alteryx Server
Common tasks — copy-paste recipes for the things you’ll do most
The safety model — why nothing destructive runs without --apply
Profiles & configuration — multiple workspaces, tokens, and per-run overrides