{"id":26763765,"url":"https://github.com/superluminar-io/aws-luminarlz-cli","last_synced_at":"2026-04-15T10:05:22.898Z","repository":{"id":282392020,"uuid":"948441796","full_name":"superluminar-io/aws-luminarlz-cli","owner":"superluminar-io","description":"A lean, opinionated CLI to make deployment and development with the AWS Landing Zone Accelerator easier.","archived":false,"fork":false,"pushed_at":"2026-04-09T07:46:27.000Z","size":1234,"stargazers_count":7,"open_issues_count":7,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-09T09:14:59.904Z","etag":null,"topics":["aws","aws-landingzone","cdk","landing-zone-accelerator","liquidjs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/superluminar-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-14T10:47:06.000Z","updated_at":"2026-04-09T07:42:42.000Z","dependencies_parsed_at":"2026-01-03T13:03:41.578Z","dependency_job_id":null,"html_url":"https://github.com/superluminar-io/aws-luminarlz-cli","commit_stats":null,"previous_names":["superluminar-io/aws-luminarlz-cli"],"tags_count":65,"template":false,"template_full_name":null,"purl":"pkg:github/superluminar-io/aws-luminarlz-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superluminar-io%2Faws-luminarlz-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superluminar-io%2Faws-luminarlz-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superluminar-io%2Faws-luminarlz-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superluminar-io%2Faws-luminarlz-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/superluminar-io","download_url":"https://codeload.github.com/superluminar-io/aws-luminarlz-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superluminar-io%2Faws-luminarlz-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31835821,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T07:17:56.427Z","status":"ssl_error","status_checked_at":"2026-04-15T07:17:30.007Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-landingzone","cdk","landing-zone-accelerator","liquidjs","typescript"],"created_at":"2025-03-28T19:34:44.145Z","updated_at":"2026-04-15T10:05:22.890Z","avatar_url":"https://github.com/superluminar-io.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AWS luminarlz CLI\n\n![NPM Version](https://img.shields.io/npm/v/%40superluminar-io%2Faws-luminarlz-cli)\n\nA lean, opinionated CLI\nto make deployment and development with the [Landing Zone Accelerator on AWS (LZA)](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws) easier.\n\n## What it does and doesn't and what you need to know\n\n - It provides a blueprint to easily set up a [well-architected AWS landing zone](https://docs.aws.amazon.com/prescriptive-guidance/latest/migration-aws-environment/welcome.html).\n - It helps you with the deployment and maintenance of the [LZA](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws).\n - It does not add any new features to the LZA.\n - In case you want, it lets you [opt out](#remove-the-aws-luminarlz-cli) and remove the dependency to the AWS luminarlz CLI completely.\n - It uses [LiquidJS](https://liquidjs.com/) to generate the LZA config files.\n - It uses [AWS CDK](https://github.com/aws/aws-cdk) to generate the [AWS Cloudformation](https://docs.aws.amazon.com/cloudformation/) templates used for the [LZA customizations](https://awslabs.github.io/landing-zone-accelerator-on-aws/latest/faq/customizations/).\n - It doesn't replace but consumes the [LZA Core CLI](https://awslabs.github.io/landing-zone-accelerator-on-aws/latest/developer-guide/scripts/#core-cli) by automatically cloning [a local LZA checkout](https://github.com/awslabs/landing-zone-accelerator-on-aws) with the correct LZA version.\n - It allows you to easily use [LZA Core CLI](https://awslabs.github.io/landing-zone-accelerator-on-aws/latest/developer-guide/scripts/#core-cli) features like [LZA config validation](https://awslabs.github.io/landing-zone-accelerator-on-aws/latest/developer-guide/scripts/#configuration-validator), [LZA Core Pipeline stage synthesis or LZA Core Pipeline stage deployment](https://awslabs.github.io/landing-zone-accelerator-on-aws/latest/developer-guide/scripts/#core-cli).\n - It's not a free lunch and still requires you to know how various AWS libraries and services work together. Here are some readings to dive into:\n   - [The LZA architecture overview](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws/architecture-overview.html).\n   - [LZA is recommended to be used together with AWS Control Tower](https://awslabs.github.io/landing-zone-accelerator-on-aws/latest/faq/ct-cfct/).\n   - [LZA supports deploying custom Cloudformation Stacks, StackSets and more](https://awslabs.github.io/landing-zone-accelerator-on-aws/latest/faq/customizations/).\n   - An LZA installation comes with the [Installer Pipeline](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws/awsaccelerator-installer.html) \u0026 the [Core Pipeline](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws/awsaccelerator-pipeline.html).\n\n### Architecture diagram\n\n![AWS luminarlz CLI Architecture diagram](docs/architecture-diagram.png)\n\n## Usage\n\n### Initialize a new AWS landing zone\n\nThis is a step-by-step guide to initialize a new AWS landing zone using the luminarlz CLI.\n\nWe'll use the [foundational blueprint](blueprints/foundational/) that is heavily aligned with the [Guidance for Establishing an Initial Foundation using Control Tower on AWS](https://aws.amazon.com/solutions/guidance/establishing-an-initial-foundation-using-control-tower-on-aws).\n\nWe recommend reading through the [Guidance](https://aws.amazon.com/solutions/guidance/establishing-an-initial-foundation-using-control-tower-on-aws) first\nas there are parts that require some manual steps and upfront planning like the root email strategy.\n\n1. Make sure you have an AWS Organizations management account which fulfils [the LZA prerequisites](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws/prerequisites.html).\n2. Make sure to [deploy the LZA](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws/deploy-the-solution.html) with the following settings:\n   - **Environment Configuration**: Leave all the defaults, `Control Tower Environment` needs to be set to `Yes`.\n   - **Config Repository Configuration**: Leave all the defaults and set `Configuration Repository Location` to `s3`.\n3. Wait until the initial LZA is [successfully deployed](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws/step-2.-await-initial-environment-deployment.html).\n4. Configure your terminal with AWS administrator credentials for the `Management` AWS account.\n5. Init the project using:\n```bash\nnpx @superluminar-io/aws-luminarlz-cli init\n```\n6. Install the new dependencies:\n```bash\nnpm install\n```\n7. Adapt the settings and fill in the open `TODOS` in the generated `config.ts` file.\n8. Have a look at the generated [README](blueprints/foundational/README.md) file\n   as it contains further documentation on how to use the AWS luminarlz CLI.\n9. Deploy your new LZA config using:\n```bash\n# You'll need the `Management` account credentials with administrator rights to be configured in your terminal.\nnpm run cli -- deploy\n```\n10. Search for open `TODO` comments in the generated files and adapt them to your needs.\n\n### Other CLI commands\n\nDocumentation for the other CLI commands can be found in the README generated when intializing a new AWS landing zone.\nHave a look at the [foundational blueprint README](blueprints/foundational/README.md).\n\n#### LZA Core CLI\n\nSome of the CLI commands are using the [LZA Core CLI](https://awslabs.github.io/landing-zone-accelerator-on-aws/latest/developer-guide/scripts/#core-cli) underneath.\n\nRunning the LZA core CLI currently requires a local checkout of the LZA repository and building the project which will take a moment.\n\nThis will be done automatically for you once and every time you update the LZA version.\n\nYou should add `/.landing-zone-accelerator-on-aws-*` to your `.gitignore` file so that these local LZA checkouts are not committed to your repository.\n\n## Development\n\n### Prerequisites\n\n- Install the node version defined in [.node-version](.node-version).\n- Install dependencies:\n```bash\nyarn projen\n```\n- To run the CLI without building it:\n```bash\n./src/index.ts\n```\n\n## Remove the AWS luminarlz CLI\n\nFor whatever reason you want to remove the dependency to the AWS luminarlz CLI you can do so.\nAfter calling:\n```bash\nnpm run cli -- synth\n```\nYou find the raw aws-accelerator-config in the `aws-accelerator-config.out` directory\nand [deploy it](https://docs.aws.amazon.com/solutions/latest/landing-zone-accelerator-on-aws/step-3.-update-the-configuration-files.html#using-s3)\nwith any other mechanism you like.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperluminar-io%2Faws-luminarlz-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuperluminar-io%2Faws-luminarlz-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperluminar-io%2Faws-luminarlz-cli/lists"}