awless/README.md

   1 ---
   2 title: awless
   3 homepage: https://github.com/wallix/awless
   4 tagline: |
   5   awless is a powerful, innovative and small surface command line interface (CLI) to manage Amazon Web Services.
   6 ---
   7
   8 To update or switch versions, run `webi awless@stable` (or `@v2`, `@beta`, etc).
   9
  10 ## Cheat Sheet
  11
  12 awless is modeled after popular command-line tools such as Git. Most commands
  13 are in the form of:
  14
  15 ```bash
  16 awless verb [entity] [parameter=value ...]
  17 ```
  18
  19 If you already have awscli installed and configured, awless will use your
  20 existing `~/.aws/credentials` file. If not, you can review and configure awless
  21 with `awless config`.
  22
  23 Unlike the standard awscli tools, `awless` aims to be more human readable.
  24
  25 ### List resources
  26
  27 For instance, let's list some resources:
  28
  29 ```bash
  30 awless list vpcs
  31 ```
  32
  33 Which outputs a friendly human readable table!
  34
  35 ```bash
  36 |         ID ▲          | NAME | DEFAULT |   STATE   |     CIDR      |
  37 |-----------------------|------|---------|-----------|---------------|
  38 | vpc-00fd208a070000000 |      | false   | available | 172.16.0.0/16 |
  39 | vpc-22222222          |      | true    | available | 172.31.0.0/16 |
  40 ```
  41
  42 There's also filter capabilities, in case the list is long. For example, let's
  43 list all EC2 instances with "api" in the name:
  44
  45 ```bash
  46 awless list instances --filter name=api
  47 ```
  48
  49 In addition to the default table output, there's also csv, tsv, json.
  50
  51 ```bash
  52 awless list loadbalancers --format csv
  53 ```
  54
  55 ### Create resources
  56
  57 awless allows specifying things by name rather than ID by using the `@` prefix.
  58
  59 ```bash
  60 awless create subnet cidr=10.0.0.0/24 vpc=@wordpress-vpc name=wordpress-public-subnet
  61 ```
  62
  63 ### Delete resources
  64
  65 If you leave out a parameter, awless will prompt you for the missing
  66 information.
  67
  68 ```bash
  69 awless delete i-123456789000abcd
  70 ```
  71
  72 It will correctly detect what you were probably trying to do:
  73
  74 ```bash
  75 Did you mean `awless delete instance ids=i-051fcef0537a53eb0` ?  [Y/n]
  76 ```
  77
  78 ### Advanced
  79
  80 For a more advanced tutorial about awless' features, see the official
  81 [Getting Started](https://github.com/wallix/awless/wiki/Getting-Started) guide.