alk command reference

This page documents every alk command, its arguments, and its options.

Note

This reference is a placeholder — it will be auto-generated from the CLI source in a future iteration.

Global options

Option	Description
--help, -h	Show help for any command.
--version, -v	Print the installed CLI version.
--yes, -y	Skip interactive confirmations. Use with care.
--dry-run	Show what would happen without making any changes.

Commands

alk setup

Initialises Alkaia in your AWS account by deploying the control-plane stack. Idempotent — safe to run multiple times.

alk whoami

Prints the AWS account ID and IAM identity Alkaia is using.

alk deploy <stack-file>

Deploys the application described by <stack-file> (a YAML file) to AWS.

alk teardown <stack-name>

Removes a deployed stack and all the AWS resources it created. Requires explicit destroy confirmation.