{"id":13602706,"url":"https://github.com/scaffold-sh/cli","last_synced_at":"2026-03-15T14:20:59.312Z","repository":{"id":143790451,"uuid":"297397297","full_name":"scaffold-sh/cli","owner":"scaffold-sh","description":"Scaffold is a framework to create a complete AWS infrastructure, defined as code, in seconds.","archived":false,"fork":false,"pushed_at":"2020-10-11T18:00:04.000Z","size":362,"stargazers_count":42,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-26T19:18:36.758Z","etag":null,"topics":["aws","cli","oclif","scaffold"],"latest_commit_sha":null,"homepage":"https://scaffold.sh/docs","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/scaffold-sh.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-09-21T16:26:47.000Z","updated_at":"2023-11-29T03:54:40.000Z","dependencies_parsed_at":"2024-01-13T19:46:37.810Z","dependency_job_id":"6b174a4e-7705-4432-8eca-37c2fb234a78","html_url":"https://github.com/scaffold-sh/cli","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaffold-sh%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaffold-sh%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaffold-sh%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaffold-sh%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scaffold-sh","download_url":"https://codeload.github.com/scaffold-sh/cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223464917,"owners_count":17149655,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","cli","oclif","scaffold"],"created_at":"2024-08-01T18:01:34.809Z","updated_at":"2025-09-23T18:28:46.257Z","avatar_url":"https://github.com/scaffold-sh.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","cli"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"/assets/scaffold.png\" alt=\"AWS\" width=\"200\" height=\"200\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eScaffold CLI\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003e\n  \u003ca href=\"https://scaffold.sh/docs\"\u003eDocumentation\u003c/a\u003e |\n  \u003ca href=\"https://scaffold.sh\"\u003eWebsite\u003c/a\u003e |\n  \u003ca href=\"https://medium.com/scaffold\"\u003eBlog\u003c/a\u003e |\n  \u003ca href=\"https://twitter.com/scaffold_sh\"\u003eTwitter\u003c/a\u003e |\n  \u003ca href=\"https://www.linkedin.com/company/scaffold-sh\"\u003eLinkedIn\u003c/a\u003e\n\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/scaffold-sh/cli/blob/master/package.json\"\u003e\u003cimg src=\"https://img.shields.io/node/v/@scaffold.sh/cli\" alt=\"Node version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://yarnpkg.com/en/docs/install\"\u003e\u003cimg src=\"https://img.shields.io/badge/yarn-%3E%3D1.21-blue\" alt=\"Yarn version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://aws.amazon.com/cli/?nc1=h_ls\"\u003e\u003cimg src=\"https://img.shields.io/badge/aws-%3E%3D2.0-0b1b2c\" alt=\"AWS version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.terraform.io/downloads.html\"\u003e\u003cimg src=\"https://img.shields.io/badge/terraform-13.0-5c44db\" alt=\"Terraform version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hashicorp/terraform-cdk\"\u003e\u003cimg src=\"https://img.shields.io/badge/cdktf-%3E%3D0.14-green\" alt=\"CDKTF version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/scaffold-sh/cli/blob/master/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/scaffold-sh/cli\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nScaffold is a framework for [IAC](https://en.wikipedia.org/wiki/Infrastructure_as_code) build around [Terraform](https://www.terraform.io) and the [CDKTF](https://learn.hashicorp.com/tutorials/terraform/cdktf), coupled with a [catalog](https://scaffold.sh/docs/infrastructures/aws/static-website) that you could use to create a complete [AWS](https://aws.amazon.com) infrastructure, defined as code, in seconds.\n\nAll infrastructures are [**open sourced**](https://github.com/scaffold-sh) and defined as **Typescript code** using the [CDK for Terraform](https://learn.hashicorp.com/tutorials/terraform/cdktf). \n\nThe CDK (Cloud Development Kit) for Terraform allows developers to use familiar programming languages to define cloud infrastructure and provision it through [HashiCorp Terraform](https://www.terraform.io/). \n\nScaffold enhances Terraform and the CDKTF with many features like [environments](https://scaffold.sh/docs/environments) and [sandboxes](https://scaffold.sh/docs/sandboxes) without using any configuration files, black box or lock-in.\n\n**You are free to go back to raw Terraform at any time.**\n\n## Prerequisites\n\nIn order to use Scaffold, you'll need Node.js, Yarn and the AWS CLI:\n\n*   [Node.js](https://nodejs.org/) \u003e= v12.16\n*   [Yarn](https://yarnpkg.com/en/docs/install) \u003e= v1.21\n*   [AWS CLI](https://aws.amazon.com/cli/?nc1=h_ls) \u003e= v2.0\n\n[Node.js](https://nodejs.org/) publishes a graphical installer that will install Node.js and NPM on your platform.\n\n[Yarn](https://yarnpkg.com/en/docs/install) is an alternate JavaScript package manager required by the CDK for Terraform.\n\nTo install the AWS CLI on your operating system, you could read the [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html).\n\n## Install Scaffold\n\nTo install the most recent stable release of Scaffold, use npm:\n\n```console\n$ npm install --global @scaffold.sh/cli\n```\n\n## Usage\n```sh-session\n$ scaffold COMMAND\nrunning command...\n$ scaffold (-v|--version|version)\n@scaffold.sh/cli/0.0.0 darwin-x64 node-v14.7.0\n$ scaffold --help [COMMAND]\nUSAGE\n  $ scaffold COMMAND\n...\n```\n## Commands\n* [`scaffold help [COMMAND]`](#scaffold-help-command)\n* [`scaffold init`](#scaffold-init)\n* [`scaffold plan ENVIRONMENT`](#scaffold-plan-environment)\n* [`scaffold apply ENVIRONMENT`](#scaffold-apply-environment)\n* [`scaffold destroy ENVIRONMENT`](#scaffold-destroy-environment)\n* [`scaffold env:create [ENVIRONMENT_NAME]`](#scaffold-envcreate-environment_name)\n* [`scaffold env:list`](#scaffold-envlist)\n* [`scaffold env:configure ENVIRONMENT`](#scaffold-envconfigure-environment)\n* [`scaffold env:delete ENVIRONMENT`](#scaffold-envdelete-environment)\n* [`scaffold sandbox:create [ENVIRONMENT]`](#scaffold-sandboxcreate-environment)\n* [`scaffold sandbox:list`](#scaffold-sandboxlist)\n* [`scaffold sandbox:delete ENVIRONMENT`](#scaffold-sandboxdelete-environment)\n* [`scaffold terraform:all`](#scaffold-terraformall)\n* [`scaffold cdktf:all`](#scaffold-cdktfall)\n* [`scaffold aws:static-website [PROJECT_NAME]`](#scaffold-awsstatic-website-project_name)\n* [`scaffold aws:serverless-docker [PROJECT_NAME]`](#scaffold-awsserverless-docker-project_name)\n\n### `scaffold help [COMMAND]`\n\nDisplay help for the Scaffold CLI.\n\n```\nUSAGE\n  $ scaffold help [COMMAND]\n\nARGUMENTS\n  COMMAND  command to show help for\n\nOPTIONS\n  --all  see all commands in CLI\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_\n\n### `scaffold init`\n\nInitialize an infrastructure.\n\n```\nUSAGE\n  $ scaffold init\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/init.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/init.ts)_\n\n### `scaffold plan ENVIRONMENT`\n\nPlan the infrastructure modifications for an environment.\n\n```\nUSAGE\n  $ scaffold plan ENVIRONMENT\n\nOPTIONS\n  -h, --help  show CLI help\n  --sandbox\n```\n\n_See code: [src/commands/plan.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/plan.ts)_\n\n### `scaffold apply ENVIRONMENT`\n\nUpdate the infrastructure of an environment.\n\n```\nUSAGE\n  $ scaffold apply ENVIRONMENT\n\nOPTIONS\n  -h, --help  show CLI help\n  --sandbox\n```\n\n_See code: [src/commands/apply.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/apply.ts)_\n\n### `scaffold destroy ENVIRONMENT`\n\nDestroy the infrastructure of an environment.\n\n```\nUSAGE\n  $ scaffold destroy ENVIRONMENT\n\nOPTIONS\n  -h, --help  show CLI help\n  --sandbox\n```\n\n_See code: [src/commands/destroy.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/destroy.ts)_\n\n### `scaffold env:create [ENVIRONMENT_NAME]`\n\nCreate a new environment.\n\n```\nUSAGE\n  $ scaffold env:create [ENVIRONMENT_NAME]\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/env/create.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/env/create.ts)_\n\n### `scaffold env:list`\n\nList all created environments.\n\n```\nUSAGE\n  $ scaffold env:list\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/env/list.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/env/list.ts)_\n\n### `scaffold env:configure ENVIRONMENT`\n\nConfigure an existing environment.\n\n```\nUSAGE\n  $ scaffold env:configure ENVIRONMENT\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/env/configure.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/env/configure.ts)_\n\n### `scaffold env:delete ENVIRONMENT`\n\nDelete an environment.\n\n```\nUSAGE\n  $ scaffold env:delete ENVIRONMENT\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/env/delete.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/env/delete.ts)_\n\n### `scaffold sandbox:create [ENVIRONMENT]`\n\nCreate a new sandbox for an environment.\n\n```\nUSAGE\n  $ scaffold sandbox:create [ENVIRONMENT]\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/sandbox/create.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/sandbox/create.ts)_\n\n### `scaffold sandbox:list`\n\nList all created sandboxes.\n\n```\nUSAGE\n  $ scaffold sandbox:list\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/sandbox/list.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/sandbox/list.ts)_\n\n### `scaffold sandbox:delete ENVIRONMENT`\n\nDelete sandbox for an environment.\n\n```\nUSAGE\n  $ scaffold sandbox:delete ENVIRONMENT\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/sandbox/delete.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/sandbox/delete.ts)_\n\n### `scaffold terraform:all`\n\nForward commands to the Terraform binary.\n\n```\nUSAGE\n  $ scaffold terraform:all\n\nOPTIONS\n  -h, --help  show CLI help\n\nALIASES\n  $ scaffold terraform:apply\n  $ scaffold terraform:console\n  $ scaffold terraform:destroy\n  $ scaffold terraform:env\n  $ scaffold terraform:fmt\n  $ scaffold terraform:get\n  $ scaffold terraform:graph\n  $ scaffold terraform:import\n  $ scaffold terraform:init\n  $ scaffold terraform:login\n  $ scaffold terraform:logout\n  $ scaffold terraform:output\n  $ scaffold terraform:plan\n  $ scaffold terraform:providers\n  $ scaffold terraform:refresh\n  $ scaffold terraform:show\n  $ scaffold terraform:taint\n  $ scaffold terraform:untaint\n  $ scaffold terraform:validate\n  $ scaffold terraform:version\n  $ scaffold terraform:workspace\n  $ scaffold terraform:0.12upgrade\n  $ scaffold terraform:0.13upgrade\n  $ scaffold terraform:debug\n  $ scaffold terraform:force-unlock\n  $ scaffold terraform:push\n  $ scaffold terraform:state\n```\n\n_See code: [src/commands/terraform/all.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/terraform/all.ts)_\n\n### `scaffold cdktf:all`\n\nForward commands to the CDKTF binary.\n\n```\nUSAGE\n  $ scaffold cdktf:all\n\nOPTIONS\n  -h, --help  show CLI help\n\nALIASES\n  $ scaffold cdktf:deploy\n  $ scaffold cdktf:destroy\n  $ scaffold cdktf:diff\n  $ scaffold cdktf:get\n  $ scaffold cdktf:init\n  $ scaffold cdktf:login\n  $ scaffold cdktf:synth\n```\n\n_See code: [src/commands/cdktf/all.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/cdktf/all.ts)_\n\n### `scaffold aws:static-website [PROJECT_NAME]`\n\nDownload the Terraform code for the [static website infrastructure](https://github.com/scaffold-sh/aws-static-website).\n\n```\nUSAGE\n  $ scaffold aws:static-website [PROJECT_NAME]\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/aws/static-website.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/aws/static-website.ts)_\n\n### `scaffold aws:serverless-docker [PROJECT_NAME]`\n\nDownload the Terraform code for the [serverless Docker infrastructure](https://github.com/scaffold-sh/aws-serverless-docker).\n\n```\nUSAGE\n  $ scaffold aws:serverless-docker [PROJECT_NAME]\n\nOPTIONS\n  -h, --help  show CLI help\n```\n\n_See code: [src/commands/aws/serverless-docker.ts](https://github.com/scaffold-sh/cli/blob/master/src/commands/aws/serverless-docker.ts)_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaffold-sh%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscaffold-sh%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaffold-sh%2Fcli/lists"}