├── .terraform_aliases ├── .terragrunt_aliases ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── generate_aliases.py └── license_header /.terraform_aliases: -------------------------------------------------------------------------------- 1 | # Copyright 2017 Google Inc. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # https://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | alias tf='terraform' 16 | alias tfa='terraform apply' 17 | alias tfc='terraform console' 18 | alias tfd='terraform destroy' 19 | alias tff='terraform fmt' 20 | alias tfg='terraform graph' 21 | alias tfim='terraform import' 22 | alias tfin='terraform init' 23 | alias tfo='terraform output' 24 | alias tfp='terraform plan' 25 | alias tfpr='terraform providers' 26 | alias tfr='terraform refresh' 27 | alias tfsh='terraform show' 28 | alias tft='terraform taint' 29 | alias tfut='terraform untaint' 30 | alias tfv='terraform validate' 31 | alias tfw='terraform workspace' 32 | alias tfs='terraform state' 33 | alias tffu='terraform force-unlock' 34 | alias tfwst='terraform workspace select' 35 | alias tfwsw='terraform workspace show' 36 | alias tfssw='terraform state show' 37 | alias tfwde='terraform workspace delete' 38 | alias tfwls='terraform workspace list' 39 | alias tfsls='terraform state list' 40 | alias tfwnw='terraform workspace new' 41 | alias tfsmv='terraform state mv' 42 | alias tfspl='terraform state pull' 43 | alias tfsph='terraform state push' 44 | alias tfsrm='terraform state rm' 45 | alias tfay='terraform apply -auto-approve' 46 | alias tfdy='terraform destroy -auto-approve' 47 | alias tfinu='terraform init -upgrade' 48 | alias tfpde='terraform plan --destroy' 49 | -------------------------------------------------------------------------------- /.terragrunt_aliases: -------------------------------------------------------------------------------- 1 | alias tg='terragrunt' 2 | alias tga='terragrunt apply' 3 | alias tgc='terragrunt console' 4 | alias tgd='terragrunt destroy' 5 | alias tgf='terragrunt fmt' 6 | alias tgg='terragrunt graph' 7 | alias tgim='terragrunt import' 8 | alias tgin='terragrunt init' 9 | alias tgo='terragrunt output' 10 | alias tgp='terragrunt plan' 11 | alias tgpr='terragrunt providers' 12 | alias tgr='terragrunt refresh' 13 | alias tgsh='terragrunt show' 14 | alias tgt='terragrunt taint' 15 | alias tgut='terragrunt untaint' 16 | alias tgv='terragrunt validate' 17 | alias tgw='terragrunt workspace' 18 | alias tgs='terragrunt state' 19 | alias tgfu='terragrunt force-unlock' 20 | alias tgwst='terragrunt workspace select' 21 | alias tgwsw='terragrunt workspace show' 22 | alias tgssw='terragrunt state show' 23 | alias tgwde='terragrunt workspace delete' 24 | alias tgwls='terragrunt workspace list' 25 | alias tgsls='terragrunt state list' 26 | alias tgwnw='terragrunt workspace new' 27 | alias tgsmv='terragrunt state mv' 28 | alias tgspl='terragrunt state pull' 29 | alias tgsph='terragrunt state push' 30 | alias tgsrm='terragrunt state rm' 31 | alias tgay='terragrunt apply -auto-approve' 32 | alias tgdy='terragrunt destroy -auto-approve' 33 | alias tginu='terragrunt init -upgrade' 34 | alias tgpde='terragrunt plan --destroy' 35 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | We'd love to accept your patches and contributions to this project. There are 4 | just a few small guidelines you need to follow. 5 | 6 | ## Contributor License Agreement 7 | 8 | Contributions to this project must be accompanied by a Contributor License 9 | Agreement. You (or your employer) retain the copyright to your contribution, 10 | this simply gives us permission to use and redistribute your contributions as 11 | part of the project. Head over to to see 12 | your current agreements on file or to sign a new one. 13 | 14 | You generally only need to submit a CLA once, so if you've already submitted one 15 | (even if it was for a different project), you probably don't need to do it 16 | again. 17 | 18 | ## Code reviews 19 | 20 | All submissions, including submissions by project members, require review. We 21 | use GitHub pull requests for this purpose. Consult 22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more 23 | information on using pull requests. 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # terraform-aliases 2 | 3 | This repository contains [a script](generate_aliases.py) to generate hundreds of 4 | convenient terraform aliases programmatically. 5 | 6 | **NOTE: The foundation of this repository is based on the amazing work done in [kubectl-aliases](https://github.com/ahmetb/kubectl-aliases) project by [@ahmetb](https://twitter.com/ahmetb).** 7 | 8 | ### Examples 9 | 10 | Some of the generated aliases are: 11 | 12 | ```sh 13 | alias tf='terraform' 14 | alias tfa='terraform apply' 15 | alias tfc='terraform console' 16 | alias tfd='terraform destroy' 17 | alias tff='terraform fmt' 18 | alias tfg='terraform graph' 19 | alias tfim='terraform import' 20 | alias tfin='terraform init' 21 | ... 22 | ``` 23 | 24 | See [the full list](.terraform_aliases). 25 | 26 | ### Installation 27 | 28 | You can directly download the [`.terraform_aliases` file](https://raw.githubusercontent.com/zer0beat/terraform-aliases/master/.terraform_aliases) 29 | and save it in your $HOME directory, then edit your .bashrc/.zshrc file with: 30 | 31 | ```sh 32 | [ -f ~/.terraform_aliases ] && source ~/.terraform_aliases 33 | ``` 34 | 35 | **Print the full command before running it:** Add this to your `.bashrc` or 36 | `.zshrc` file: 37 | 38 | ```sh 39 | function terraform() { echo "+ terraform $@"; command terraform $@; } 40 | ``` 41 | 42 | ### Terragrunt aliases 43 | 44 | 45 | You can directly download the [`.terragrunt_aliases` file](https://raw.githubusercontent.com/zer0beat/terraform-aliases/master/.terragrunt_aliases) 46 | and save it in your $HOME directory, then edit your .bashrc/.zshrc file with: 47 | 48 | ```sh 49 | [ -f ~/.terragrunt_aliases ] && source ~/.terragrunt_aliases 50 | ``` 51 | 52 | **Print the full command before running it:** Add this to your `.bashrc` or 53 | `.zshrc` file: 54 | 55 | ```sh 56 | function terragrunt() { echo "+ terragrunt $@"; command terragrunt $@; } 57 | ``` 58 | 59 | ### FAQ 60 | 61 | **Does this not slow down my shell start up?** Sourcing the file that contains 62 | ~500 aliases takes about 30-45 milliseconds in my shell (zsh). I don't think 63 | it's a big deal for me. Measure it with `echo $(($(date +%s%N)/1000000))` 64 | command yourself in your .bashrc/.zshrc. 65 | 66 | ### Authors 67 | 68 | - [@ahmetb](https://twitter.com/ahmetb) 69 | - [@zer0beat](https://twitter.com/zer0beat) 70 | -------------------------------------------------------------------------------- /generate_aliases.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright 2017 Google Inc. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | 18 | from __future__ import print_function 19 | import itertools 20 | import os.path 21 | import sys 22 | 23 | try: 24 | xrange # Python 2 25 | except NameError: 26 | xrange = range # Python 3 27 | 28 | 29 | def main(): 30 | # (alias, full, allow_when_oneof, incompatible_with) 31 | cmds = [ 32 | ('tf', 'terraform', None, None), 33 | ('tg', 'terragrunt', None, None) 34 | ] 35 | 36 | globs = [] 37 | 38 | ops = [ 39 | ('a', 'apply', None, None), 40 | ('c', 'console', None, None), 41 | ('d', 'destroy', None, None), 42 | ('f', 'fmt', None, None), 43 | ('g', 'graph', None, None), 44 | ('im', 'import', None, None), 45 | ('in', 'init', None, None), 46 | ('o', 'output', None, None), 47 | ('p', 'plan', None, None), 48 | ('pr', 'providers', None, None), 49 | ('r', 'refresh', None, None), 50 | ('sh', 'show', None, None), 51 | ('t', 'taint', None, None), 52 | ('ut', 'untaint', None, None), 53 | ('v', 'validate', None, None), 54 | ('w', 'workspace', None, None), 55 | ('s', 'state', None, None), 56 | ('fu', 'force-unlock', None, None), 57 | ] 58 | 59 | res = [ 60 | ('st', 'select', ['w'], None), 61 | ('sw', 'show', ['w', 's'], None), 62 | ('de', 'delete', ['w'], None), 63 | ('ls', 'list', ['w', 's'], None), 64 | ('nw', 'new', ['w'], None), 65 | ('mv', 'mv', ['s'], None), 66 | ('pl', 'pull', ['s'], None), 67 | ('ph', 'push', ['s'], None), 68 | ('rm', 'rm', ['s'], None), 69 | ] 70 | res_types = [r[0] for r in res] 71 | 72 | args = [ 73 | ('y', '-auto-approve', ['a', 'd'], None), 74 | ('u', '-upgrade', ['in'], None), 75 | ('de', '--destroy', ['p'], ['y']), 76 | ] 77 | 78 | # these accept a value, so they need to be at the end and 79 | # mutually exclusive within each other. 80 | positional_args = [] 81 | 82 | # [(part, optional, take_exactly_one)] 83 | parts = [ 84 | (cmds, False, True), 85 | (globs, True, False), 86 | (ops, True, True), 87 | (res, True, True), 88 | (args, True, False), 89 | (positional_args, True, True), 90 | ] 91 | 92 | out = gen(parts) 93 | out = filter(is_valid, out) 94 | 95 | # prepare output 96 | if not sys.stdout.isatty(): 97 | header_path = \ 98 | os.path.join(os.path.dirname(os.path.realpath(__file__)), 99 | 'license_header') 100 | with open(header_path, 'r') as f: 101 | print(f.read()) 102 | for cmd in out: 103 | print("alias {}='{}'".format(''.join([a[0] for a in cmd]), 104 | ' '.join([a[1] for a in cmd]))) 105 | 106 | 107 | def gen(parts): 108 | out = [()] 109 | for (items, optional, take_exactly_one) in parts: 110 | orig = list(out) 111 | combos = [] 112 | 113 | if optional and take_exactly_one: 114 | combos = combos.append([]) 115 | 116 | if take_exactly_one: 117 | combos = combinations(items, 1, include_0=optional) 118 | else: 119 | combos = combinations(items, len(items), include_0=optional) 120 | 121 | # permutate the combinations if optional (args are not positional) 122 | if optional: 123 | new_combos = [] 124 | for c in combos: 125 | new_combos += list(itertools.permutations(c)) 126 | combos = new_combos 127 | 128 | new_out = [] 129 | for segment in combos: 130 | for stuff in orig: 131 | new_out.append(stuff + segment) 132 | out = new_out 133 | return out 134 | 135 | 136 | def is_valid(cmd): 137 | for i in xrange(0, len(cmd)): 138 | 139 | # check at least one of requirements are in the cmd 140 | requirements = cmd[i][2] 141 | if requirements: 142 | found = False 143 | for r in requirements: 144 | for j in xrange(0, i): 145 | if cmd[j][0] == r: 146 | found = True 147 | break 148 | if found: 149 | break 150 | if not found: 151 | return False 152 | 153 | # check none of the incompatibilities are in the cmd 154 | incompatibilities = cmd[i][3] 155 | if incompatibilities: 156 | found = False 157 | for inc in incompatibilities: 158 | for j in xrange(0, i): 159 | if cmd[j][0] == inc: 160 | found = True 161 | break 162 | if found: 163 | break 164 | if found: 165 | return False 166 | 167 | return True 168 | 169 | 170 | def combinations(a, n, include_0=True): 171 | l = [] 172 | for j in xrange(0, n + 1): 173 | if not include_0 and j == 0: 174 | continue 175 | l += list(itertools.combinations(a, j)) 176 | return l 177 | 178 | 179 | def diff(a, b): 180 | return list(set(a) - set(b)) 181 | 182 | 183 | if __name__ == '__main__': 184 | main() 185 | -------------------------------------------------------------------------------- /license_header: -------------------------------------------------------------------------------- 1 | # Copyright 2017 Google Inc. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # https://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | --------------------------------------------------------------------------------