sailfork / t3code-github / .repos/ alchemy-effect/ website/ src/ content/ docs/ cli/ plan.mdx

import Terminal from "../../../components/Terminal.astro";
alchemy plan [options]

plan previews what would change without applying anything — it is equivalent to alchemy deploy --dry-run.

<Terminal content={`[u]Plan[/u]: [g]1 to create[/g], [y]1 to update[/y]

[g]+[/g] [b]Queue[/b] d[/d] [y]~[/y] [b]Worker[/b] d[/d]`} />

The plan uses + for creates, ~ for updates, - for deletes, and • for no-ops. No approval prompt is shown and no changes are made.

Detailed property changes

Pass --detailed to show declared resource inputs as YAML:

alchemy plan --detailed

<Terminal content={`[u]Plan[/u]: [g]1 to create[/g], [y]1 to update[/y]

[g]+[/g] [b]EventsQueue[/b] [s2][g]properties:[/g] [s4]fifo: true [s4]visibilityTimeout: 30

[y]~[/y] [b]OrderHandler[/b] [s2][r]before:[/r] [s4]memorySize: 512 [s4]env: [s6]MODE: development [s2][g]after:[/g] [s4]memorySize: 1024 [s4]env: [s6]MODE: production`} />

Creates show their desired properties. Updates and replacements show the previously persisted declared properties followed by the desired properties; this is a declaration diff, not a live-cloud drift read. Outputs appear as (known after apply), computed values as (computed), and secrets remain redacted. Deletes stay compact.

Flags

OptionDescription
--config, -c <file>Stack file to plan (defaults to alchemy.run.ts)
--stage <name>Stage to plan against (defaults to $ALCHEMY_STAGE or live_$USER)
--profile <name>Auth profile to use (defaults to $ALCHEMY_PROFILE or default)
--env-file <path>Load environment variables from a file
--adoptPlan adoption of pre-existing cloud resources that conflict with this stack instead of failing (see Adopting Resources)
--detailedShow declared resource properties as YAML

Where next