Skip to main content
The Lowkey installer is the script you get from install.lowkey.run. You can run it interactively (it walks you through every choice) or pass flags to skip the prompts entirely. This page covers every flag, the environment variables the installer respects, and the exit codes it returns.

Flag reference

Any explicit flag wins over an environment variable, which wins over the pack manifest default.

Canonical non-interactive invocations

Use -y combined with --pack and --profile to deploy without any prompts.

Terraform deploy method

Pass --method terraform to have the installer run Terraform instead of CloudFormation:
The installer runs terraform initvalidateapply -auto-approve under deploy/terraform/. If you want to review the plan before it applies, deploy Terraform directly instead — see Deploy Lowkey with Terraform.

Advanced mode

Advanced mode prompts for every parameter: VPC reuse, instance type, data volume size, region, and each security service individually. Pass --advanced to enable it, even alongside -y:
Advanced mode still honors -y for prompts that have a clear safe default. It only stops to ask for choices that genuinely need a decision.

Connect via SSM after install

SSH is disabled by default (SSHAllowedCidr=127.0.0.1/32). Once your stack reaches CREATE_COMPLETE, connect using AWS Systems Manager Session Manager:
Find the instance ID in the CloudFormation stack Outputs tab, or retrieve it from the CLI:
To enable SSH, redeploy in advanced mode and set SSHAllowedCidr to your IP CIDR (for example, 1.2.3.4/32).

Environment variables honored

Set these in your shell before piping the installer to bash:

Exit codes