{"id":13526914,"url":"https://github.com/wallix/awless","last_synced_at":"2025-05-14T14:08:53.713Z","repository":{"id":41280901,"uuid":"60350949","full_name":"wallix/awless","owner":"wallix","description":"A Mighty CLI for AWS","archived":false,"fork":false,"pushed_at":"2022-08-02T00:04:44.000Z","size":19305,"stargazers_count":4978,"open_issues_count":119,"forks_count":262,"subscribers_count":91,"default_branch":"master","last_synced_at":"2025-04-11T18:23:09.199Z","etag":null,"topics":["awless","aws","aws-cli","cli","cloud","cloud-management","devops","devops-tools","golang"],"latest_commit_sha":null,"homepage":"http://awless.io/","language":"Go","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/wallix.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-03T13:46:18.000Z","updated_at":"2025-04-09T13:25:05.000Z","dependencies_parsed_at":"2022-07-18T10:39:26.297Z","dependency_job_id":null,"html_url":"https://github.com/wallix/awless","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wallix%2Fawless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wallix%2Fawless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wallix%2Fawless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wallix%2Fawless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wallix","download_url":"https://codeload.github.com/wallix/awless/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254160007,"owners_count":22024566,"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":["awless","aws","aws-cli","cli","cloud","cloud-management","devops","devops-tools","golang"],"created_at":"2024-08-01T06:01:37.351Z","updated_at":"2025-05-14T14:08:48.704Z","avatar_url":"https://github.com/wallix.png","language":"Go","readme":"\n\n[![Build Status](https://api.travis-ci.org/wallix/awless.svg?branch=master)](https://travis-ci.org/wallix/awless)\n[![Go Report Card](https://goreportcard.com/badge/github.com/wallix/awless)](https://goreportcard.com/report/github.com/wallix/awless)\n\n\u003cimg src=\"https://user-images.githubusercontent.com/808274/33351381-5b9a0d00-d458-11e7-91ed-cf7ada7237c1.png\" alt=\"terminal icon\" width=\"48\"\u003e `awless` is a powerful, innovative and small surface command line interface (CLI) to manage Amazon Web Services.\n\n[Twitter](http://twitter.com/awlessCLI) | [Wiki](https://github.com/wallix/awless/wiki) | [Changelog](https://github.com/wallix/awless/blob/master/CHANGELOG.md#readme)\n\n# Why awless\n\n`awless` stands out by having the following characteristics:\n\n- small and hierarchical set of commands\n- a simple/powerful text [templating language](https://github.com/wallix/awless/wiki/Templates) to create and **revert** fully-fledged infrastructures \n- wrapping/composing AWS API calls when necessary to enrich behaviour. Ex: ensure smart defaults, security best practices, etc. \n- local log of all your cloud modifications done through `awless` to list/revert past actions\n- sync to a local graph storage of your cloud representation \n- exploration of your cloud infrastructure and resources interrelations, **even offline** using the local graph storage\n- clearer and flexible terminal output's with: numerous formats (machine/human friendly), enriched resources's properties/relations when feasible\n- connect easily using awless' **smart SSH** to your private \u0026 public instances\n\nFor more read our [FAQ](#faq) below (how `awless` compares to other tools, etc.)\n\n# Install\n\nChoose one of the following options:\n\n1. On macOS, use [homebrew](http://brew.sh):  `brew tap wallix/awless; brew install awless`\n2. With `curl` (macOS/Linux), run: `curl https://raw.githubusercontent.com/wallix/awless/master/getawless.sh | bash`\n3. Download the latest `awless` binaries (Windows/Linux/macOS) [from Github](https://github.com/wallix/awless/releases/latest)\n4. If you have Golang already installed, install from the source with: `go get -u github.com/wallix/awless`\n\nIf you have previously used the AWS CLI or aws-shell, you don't need to configure anything! Your config will be automatically loaded (i.e. ~/.aws/{credentials,config}) and `awless` will prompt for any missing info (more at our [getting started](https://github.com/wallix/awless/wiki/Getting-Started)).\n\n# Main features\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/wiki/wallix/awless/apng/awless-demo.png\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/wiki/wallix/awless/apng/awless-demo.png\" alt=\"video of a few awless commands\"\u003e\u003c/a\u003e\n\u003cbr/\u003e\n\u003cem\u003eNote that the video above is in \u003ca href=\"https://en.wikipedia.org/wiki/APNG\"\u003eAPNG\u003c/a\u003e and requires a recent browser.\u003c/em\u003e\n\u003c/p\u003e\n\n- **Aliasing of resources through their natural name** so you don't have to always use cryptic ids that are impossible to remember\n- `awless show` : Explore the  properties, relations, dependencies of a specific resource (even offline thanks to the sync) given only a *name* (or id/arn).\n\n      $ awless show jsmith --local\n\n- `awless list` : Clear and easy listing of multi-region cloud resources (subnets, instances, users, buckets, records, etc.) on AWS EC2, IAM, S3, RDS, AutoScaling, SNS, SQS, Route53, CloudWatch, CloudFormation, Lambda, etc. Listing filters via *resources properties* or *resources tags*.\n\n      $ awless list instances --sort uptime --local\n      $ awless list users --format csv --columns name,created\n      $ awless list volumes --filter state=use --filter type=gp2\n      $ awless list volumes --tag-value Purchased\n      $ awless ls vpcs --tag-key Dept --tag-key Internal --format tsv\n      $ awless ls instances --tag Env=Production,Dept=Marketing\n      $ awless ls instances --filter state=running,type=micro --format json\n      $ awless ls s3objects --filter bucket=pdf-bucket -r us-west-2\n      $ ...\n      (see awless ls -h)\n\n- `awless run` : Create, update and delete complex infrastructures with smart defaults and sound auto-complete through awless templates.\n\n      $ awless run ~/templates/my-infra.aws\n      $ awless run https://raw.githubusercontent.com/wallix/awless-templates/master/linux_bastion.aws\n      etc.\n\n- **Hundreds of powerful CRUD CLI one-liners** integrated in the awless templating engine:\n\n      $ awless create instance -h\n      $ awless create vpc -h\n      $ awless attach policy -h\n      $ ...\n      (see awless -h)\n\n- `awless log` : Detailled and easy reporting of all the CLI template executions\n- `awless revert` : Revert of executed templates and resources creation\n- Create instances straight from a distro name. No need to know the region or AMI ;) (_free tier community bare distro only_, see `awless create instance -h`)\n\n      $ awless create instance distro=debian\n      $ awless create instance distro=coreos\n      $ awless create instance distro=redhat::7.2 type=t2.micro\n      $ awless create instance distro=debian:debian:jessie lock=true\n      $ awless create instance distro=amazonlinux:amzn2\n      etc.\n\n- Leveraging AWS `userdata` to provision instance on creation from remote (i.e http) or local scripts: `awless create instance ... userdata=/home/john/...` \n- `awless ssh` : Clean and simple SSH to public \u0026 private instances using only a name\n\n      $ awless ssh my-production-instance\n      $ awless ssh redis-prod --through jump-server\n      $ awless ssh 34.215.29.221\n      $ awless ssh db-private --private\n      $ awless ssh 172.31.77.151 --port 2222 --through my-proxy --through-port 23\n      $ ...\n      (see awless ssh -h)\n\n- `awless switch` : Switch easily between AWS accounts (i.e. profile) and regions\n\n      $ awless switch admin eu-west-2\n      $ awless switch us-west-1\n      $ awless switch mfa\n      etc.\n\n- `awless` transparently syncs cloud resources locally to a graph representation in order for the CLI to leverage data and their relations in other awless commands and in an offline manner ([more on the sync](https://github.com/wallix/awless/wiki/Getting-Started#sync))\n- `awless sync` : Explicit and manual command to fetch \u0026 store resources locally. Then query \u0026 inspect your cloud offline\n- Output listing formats either human (**default display is Markdown-compatible tables**) or machine readable (csv, tsv, json, ...): `--format`\n- `awless inspect` : Leverage **experimental** and community inspectors which are interface implementation utilities to run analysis on your cloud resources graphs\n\n      $ awless inspect -i bucket_sizer\n      (see awless inspect -h)\n\n- `awless completion` : CLI autocompletion for Unix/Linux's bash and zsh \n\n# Getting started\n\nTake the tour at [Getting Started (wiki)](https://github.com/wallix/awless/wiki/Getting-Started) or read the [introductory blog post about awless](https://medium.com/@hbbio/awless-io-a-mighty-cli-for-aws-a0d48bdb59a4).\n\nMore articles:\n\n   - [Simplified Multi-Factor Authentication for AWS](https://medium.com/@awlessCLI/simplified-multi-factor-authentication-for-aws-d703e8d9f332)\n   - [Simplified user management for AWS](https://medium.com/@awlessCLI/simplified-user-management-for-aws-6f828ccab387)\n   - [InfoWorld: Production-grade deployment of WordPress](https://www.infoworld.com/article/3230547/cloud-computing/awless-tutorial-try-a-smarter-cli-for-aws.html)\n   - [Easy create \u0026 tear down of a multi-AZ CockroachDB cluster](https://github.com/wallix/awless-templates/tree/master/cockroachdb)\n   - [Deploy Vuls.io to an AWS instance and scan for vulnerabilities](https://github.com/wallix/awless-templates/tree/master/vuln_scanners)\n\n# Awards\n\n- [Top 50 Developer Tools of 2017](https://stackshare.io/posts/top-developer-tools-2017)\n- [InfoWorld Bossie Awards 2017](https://www.infoworld.com/article/3227920/cloud-computing/bossie-awards-2017-the-best-cloud-computing-software.html#slide12)\n\n# FAQ\n\nHere is a compilation of the question we often answer (thanks for asking them so that we can make things clearer!):\n\n**There are already some AWS CLIs. What is `awless` unique approach?**\n\nThree things that differentiates `awless` from other AWS CLIs:\n\n* It has its own **compiled and very simple templating language** to build AWS infrastructures.\n* Commands are made of _VERB + ENTITY [+ param=value]_ and are actually valid lines of the template language. \n* It transparently syncs to a local graph a representation of the cloud resources and their relations.\n\nLeveraging and combining the points above, `awless` lays some strong foundations for plenty of current/future features/characteristic such as:\n\n- Wrapping AWS API calls to enrich them with before/after behaviour when interacting with the cloud\n- Having a small and hierarchical set of commands to intuitively interact with AWS\n- Enriching listing of resources using the local model and relations that are not calculated with other CLIs\n- Referencing and finding resources quickly avoiding cryptic IDs in favor of names, etc.\n- Exposing in the terminal relation between resources: lineage, siblings, etc.\n- Performing local analysis of your cloud\n- Having a smart SSH to easily connect to instances\n- etc.\n\n**How do you create infrastructure with `awless`?**\n\nYou build infrastructure using `template files` or `command one-liners` that get compiled and run through `awless` builtin engine. See [what the templating language looks like](https://github.com/wallix/awless-templates/blob/master/cockroachdb/cockroach_insecure_cluster.aws). Learn [more about the way templates work](https://github.com/wallix/awless/wiki/Templates)\n\nNote that all your actions against the cloud are logged. Templates are revertible/rollbackable.\n\n**How does `awless` compares to `aws-shell` or `saws`?**\n\n(Points above should also help answering this question)\n\n`aws-shell` and `saws` are directly mapped to the official AWS CLI. Their **only** objective is to make you productive and help you manage exhaustively the sheer number of AWS services, options, etc.\n\n`awless` addresses this UI/productivity concern differently: small and hierarchical set of commands; favoring enriched listing with relations showing over AWS exhaustive outputting of properties; more useful human/machine formats.\n\nThe main point is that **the UI/productivity concern is just a feature of awless and not its primary or only one**, so there is much more to the tool.\n\nAlso `aws-shell` and `saws` are exhaustive in their support of AWS services. `awless` is so far more infrastructure centric, with an emphasis on enriching the information about your real infrastructure. `awless` is able to add any new AWS service quickly if that fits and make sense (see wiki on how to add a new AWS service).\n\n**How does `awless` compares to Terraform?**\n\nTerraform is a great product! `awless` is much younger than Terraform and Terraform is much broader in scope. \n\nThe approach is different though. When creating insfrastructure `awless`:\n\n- favors simplicity with a straight forward, compiled and simple deployment language\n- employs an all-or-nothing deployment: do not keep state, etc.\n- `awless` does provide a rollback on any ran template.\n\n**Does `awless` handles state when creating infrastructure (i.e. keep track of the changes)?**\n\nQuoting from a [logz.io/blog entry](https://logz.io/blog/terraform-ansible-puppet/): _\"Terraform is an amazing tool but a major challenge is managing the state file. Whenever you apply changes to your infrastructure, the entire managed body of code and created objects are tracked in the Terraform State file (.tfstate), which can reach hundreds of thousands of lines and must be managed carefully lest you incur large merge conflicts or unwanted resource changes\"_, Ofer Velich.\n\nAs for now with `awless`, we have taken a different path: `awless` does not keep state of your cloud; it is more of an all-or-nothing deployment solution. \n\nNote that `awless` logs (through rich and revertable logs) all your actions against the cloud and that you can revert any template ran.\n\n# About\n\n`awless` is an open source project created by Henri Binsztok, Quentin Bourgerie, Simon Caplette and François-Xavier Aguessy at WALLIX.\n`awless` is released under the Apache License and sponsored by [Wallix](https://github.com/wallix).\n\n    Disclaimer: Awless allows for easy resource creation with your cloud provider;\n    we will not be responsible for any cloud costs incurred (even if you create a \n    million instances using awless templates).\n\nContributors are welcome! Please head to [Contributing (wiki)](https://github.com/wallix/awless/wiki/Contributing) to learn more.\nNote that `awless` uses [triplestore](https://github.com/wallix/triplestore) another project developped at WALLIX.\n","funding_links":[],"categories":["Go","\\*nix/\\*nux","\u003ca id=\"c71ad1932bbf9c908af83917fe1fd5da\"\u003e\u003c/a\u003eAWS","AWS","Open Source Repos","Applications","Amazon Web Services"],"sub_categories":["Cloud Services","\u003ca id=\"0476f6b97e87176da0a0d7328f8747e7\"\u003e\u003c/a\u003eblog","CLI","Directory Navigation"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwallix%2Fawless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwallix%2Fawless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwallix%2Fawless/lists"}