{"id":13814529,"url":"https://github.com/widdix/aws-cf-templates-cli","last_synced_at":"2025-07-09T23:03:46.994Z","repository":{"id":33935398,"uuid":"141238553","full_name":"widdix/aws-cf-templates-cli","owner":"widdix","description":"widdix, a CLI tool to manage Free Templates for AWS CloudFormation","archived":false,"fork":false,"pushed_at":"2025-01-15T08:11:09.000Z","size":296,"stargazers_count":47,"open_issues_count":2,"forks_count":14,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-24T09:07:25.615Z","etag":null,"topics":["amazon-web-services","aws","aws-cloudformation","cloudformation","cloudformation-template","cloudformation-templates"],"latest_commit_sha":null,"homepage":"http://templates.cloudonaut.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/widdix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"widdix"}},"created_at":"2018-07-17T05:58:42.000Z","updated_at":"2024-07-23T11:09:59.000Z","dependencies_parsed_at":"2024-07-23T13:02:51.009Z","dependency_job_id":"3d19ebfd-28dd-4b51-8757-5da421e50660","html_url":"https://github.com/widdix/aws-cf-templates-cli","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/widdix/aws-cf-templates-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdix%2Faws-cf-templates-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdix%2Faws-cf-templates-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdix%2Faws-cf-templates-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdix%2Faws-cf-templates-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/widdix","download_url":"https://codeload.github.com/widdix/aws-cf-templates-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdix%2Faws-cf-templates-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264504928,"owners_count":23618870,"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":["amazon-web-services","aws","aws-cloudformation","cloudformation","cloudformation-template","cloudformation-templates"],"created_at":"2024-08-04T04:02:07.859Z","updated_at":"2025-07-09T23:03:46.925Z","avatar_url":"https://github.com/widdix.png","language":"JavaScript","funding_links":["https://github.com/sponsors/widdix"],"categories":["JavaScript"],"sub_categories":[],"readme":"# widdix CLI\n\n`widdix`, a CLI tool to manage [Free Templates for AWS CloudFormation](https://github.com/widdix/aws-cf-templates).\n\n\u003e The widdix CLI is compatible with templates \u003e= v6.13.0\n\n## Install\n\nWe provide three ways to install `widdix`. Via `npm`, Docker, or by downloading the binary manually.\n\n### npm\n\nIf you have `npx` installed (comes with `npm\u003e=5.2.0`) you can prefix all `widdix` invocations with `npx`. E.g. `npx widdix list --all-profiles`.\n\nOr you can install `widdix` globally with `npm install -g widdix`.\n\n### Docker\n\nDocker image available on Ducker Hub [widdix/widdix](https://hub.docker.com/r/widdix/widdix/).\n\nUsage: `docker run -it --rm -v \"$HOME/.aws:/root/.aws:ro\" widdix/widdix list --all-profiles`\n\n### Binary\n\n\u003e We don't provide binaries any longer since [pkg](https://www.npmjs.com/package/pkg) does not support ESM.\n\n## AWS Authorization \u0026 Authentication (IAM)\n\n### --env\n\nIf you append the `--env` parameter, the following environment variables are used: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN`\n\n### --profile=\u003cname\u003e\n\nIf you append the `--profile=\u003cname\u003e` parameter, the profile is loaded from ` ~/.aws/credentials` (MFA is supported).\n\n### --all-profiles\n\nIf you append the `--all-profiles` parameter, all profiles from ` ~/.aws/credentials` are loaded (MFA is supported).\n\n### default\n\nIf nothing is specified, the [AWS SDK for Node.js default behavior](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) applies.\n\n## Available Commands\n\n### List\n\nTo list all your stacks in an AWS account, run:\n\n```\nwiddix list\n```\n\nA sample output looks like this:\n\n```\n-----------------------------------------------------------------------------------------------------------------------------------------\n| Stack Account | Stack Region | Stack Name              | Template ID                        | Template Version       | Template Drift |\n-----------------------------------------------------------------------------------------------------------------------------------------\n| 123456789123  | eu-west-1    | operations-alert        | operations/alert                   | 6.14.0                 | false          |\n| 123456789123  | eu-west-1    | jenkins-vpc-auth-proxy  | security/auth-proxy-ha-github-orga | 6.14.0                 | false          |\n| 123456789123  | eu-west-1    | jenkins-ha-agents       | jenkins/jenkins2-ha-agents         | 6.13.0 (latest 6.14.0) | false          |\n| 123456789123  | eu-west-1    | jenkins-vpc-ssh-bastion | vpc/vpc-ssh-bastion                | 6.14.0                 | false          |\n| 123456789123  | eu-west-1    | jenkins-vpc-2azs        | vpc/vpc-2azs                       | 6.14.0                 | false          |\n-----------------------------------------------------------------------------------------------------------------------------------------\n```\n\nTo filter a AWS single region, run:\n\n```\nwiddix list --region=us-east-1\n```\n\n#### Columns\n\n| Column           | Description                                                                            |\n| ---------------- | -------------------------------------------------------------------------------------- |\n| Stack Account    | AWS account alias or ID.                                                               |\n| Stack Region     | AWS region, like `us-east-1`.                                                          |\n| Stack Name       | Name of AWS CloudFormation stack.                                                      |\n| Template ID      | Template id, like `vpc/vpc-2azs`.                                                      |\n| Template Version | Current version of the template. If an update is available it is added in parentheses. |\n| Template Drift   | If you modified the template drift is detected.                                        |\n\n### Graph\n\n![Graph](graph.png)\n\nTo generate a graph in [DOT](https://graphviz.gitlab.io/_pages/doc/info/lang.html) format of your stacks in an AWS account, run:\n\n```\nwiddix graph\n```\n\nTo filter a single AWS region, run:\n\n```\nwiddix graph --region=us-east-1\n```\n\nDo visualize the graph in a png file, pipe stdout to `dot`:\n\n```\nwiddix graph | dot -Tpng \u003e graph.png\n```\n\nIf you don't have `dot` installed, you can also use Docker:\n\n```\nwiddix graph | docker run -i robhaswell/dot-docker -Tpng \u003e graph.png\n```\n\n### Update\n\nIf a new version of the template is released, you can update your existing stacks. To update all stacks in interactive mode, run:\n\n```\nwiddix update\n```\n\nThe update behaves as follows:\n\n1. If no updates are available, an error is thrown.\n1. If template drift is detected we do not recommend to update! You have to confirm this potentially destructive action by typing `yes`.\n1. Planed changes (using AWS CloudFormation change sets) that are necessary to migrate to the new version are displayed. \n1. You have to confirm the changes by typing `yes`.\n1. Changes are applied and CloudWatch events are streamed to your screen.\n\nYou can filter AWS CloudFormation stacks based on region and/or AWS CloudFormation stack name like this:\n\n```\nwiddix update --region=us-east-1 --stack-name=vpc\n```\n\n## Future Commands\n\n### Catalogue\n\nList all available templates that can be installed.\n\n\u003e Not yet implemented!\n\n### Get\n\nGet information about a single stack.\n\n\u003e Not yet implemented!\n\n### Create\n\nCreate a new stack from a template in the catalogue. If the template needs connect to dependent stacks, you will be asked to select one of the existing stacks (if available) or to create the dependent stack as well.\n\n\u003e Not yet implemented!\n\n### Delete\n\n\u003e Not yet implemented!\n\n## Config\n\n### Proxy\n\nThe `HTTPS_PROXY` environment variable is used if set.\n\n## Debug\n\nIf something goes wrong, a log file (`widdix.log`) is written to the current working directory.\n\nIf you append the `--debug` parameter the log will be more verbose.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwiddix%2Faws-cf-templates-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwiddix%2Faws-cf-templates-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwiddix%2Faws-cf-templates-cli/lists"}