Automaton CLI

The CLI manages the local project link and sends the configured application to Automaton. Read automaton.json and the generated local guidance before editing.

Install and authenticate

dotnet tool install -g Automaton.Cli
automaton --version
automaton login

For unattended use, configure AUTOMATON_API_KEY in the process environment and use the command's non-interactive option where available. Do not paste keys into an AI conversation.

Create or link

automaton new "My App"
automaton link <app-id-or-slug>

automaton new creates a valid local automaton.json, creates a remote app, and records its ID in the selected local profile. It also syncs the generated AI guidance. automaton link requires an existing valid automaton.json and records the remote app ID in the selected profile without downloading or changing local source or guidance files. After linking, deploy the local source with automaton deploy.

automaton pull <app-id-or-slug> creates a new local project from portable remote source. App IDs work for accessible apps; exact public slugs are resolved from the apps visible to your account, so project apps may require an app ID. Pulling into an existing linked project warns before overwriting matching files and stages downloads before exposing them locally.

If remote creation fails after the local file is written, run:

automaton validate
automaton create
automaton deploy

Configure and deploy

Declare the generic application contract in automaton.json. It supports an optional build command, a runtime command, an HTTP health path, durable storage, working directories, environment values, and timeouts.

automaton validate
automaton deploy

The Runner performs the configured build and starts the configured runtime. The deployment operation is asynchronous. Wait for Succeeded, then verify the deployed URL.

Other commands

automaton sync-ai
automaton pull
automaton runners
automaton publish

sync-ai restores the canonical local guidance files. pull downloads app source. runners lists available Runners. publish makes the latest deployment public and requires explicit user approval.

The optional positional argument to automaton deploy selects a remote deployment target. Its --env <name> option instead selects a local project profile for credentials and app linkage.

Use automaton publish only after deployment and approval.