├── .gitignore ├── LICENSE ├── README.md ├── generate.sh └── sfdx.bash /.gitignore: -------------------------------------------------------------------------------- 1 | commands-list.json 2 | commands-display.json -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # salesforce-cli-bash-completion 2 | 3 | Auto-completion for the Salesforce CLI in bash. 4 | 5 | ## Installation 6 | 7 | Clone and open this repository: 8 | 9 | ``` 10 | git clone https://github.com/wadewegner/salesforce-cli-bash-completion && cd salesforce-cli-bash-completion 11 | ``` 12 | 13 | Update your `.bash_profile`: 14 | 15 | ``` 16 | printf "\nsource '"$(pwd)"/sfdx.bash'\n" >> ~/.bash_profile 17 | ``` 18 | 19 | Reload your profile: 20 | 21 | ``` 22 | source ~/.bash_profile 23 | ``` 24 | 25 | Enjoy! -------------------------------------------------------------------------------- /generate.sh: -------------------------------------------------------------------------------- 1 | # remove SFDX spinner 2 | export FORCE_SPINNER_DELAY= 3 | export FORCE_SHOW_SPINNER= 4 | 5 | # create the commands-list.json file 6 | sfdx force:doc:commands:list --json | jq -r .result > commands-list.json 7 | sfdx force:doc:commands:display --json | jq '.result[] | select((.command) != null)' > commands-display.json 8 | 9 | completion="" 10 | completion+="#!/usr/bin/env bash" 11 | completion+="\n" 12 | completion+="\n# DESCRIPTION: Bash completion script for the Salesforce CLI" 13 | completion+="\n# AUTHOR: Wade Wegner (@WadeWegner)" 14 | completion+="\n# REPO: https://github.com/wadewegner/salesforce-cli-bash-completion" 15 | completion+="\n# LICENSE: https://github.com/wadewegner/salesforce-cli-bash-completion/blob/master/LICENSE" 16 | completion+="\n" 17 | 18 | completion+="\nif ! type __ltrim_colon_completions >/dev/null 2>&1; then" 19 | completion+="\n # Copyright © 2006-2008, Ian Macdonald " 20 | completion+="\n # © 2009-2017, Bash Completion Maintainers" 21 | completion+="\n __ltrim_colon_completions() {" 22 | completion+="\n # If word-to-complete contains a colon," 23 | completion+="\n # and bash-version < 4," 24 | completion+="\n # or bash-version >= 4 and COMP_WORDBREAKS contains a colon" 25 | completion+="\n if [[" 26 | completion+="\n \"\$1\" == *:* && (" 27 | completion+="\n \${BASH_VERSINFO[0]} -lt 4 ||" 28 | completion+="\n (\${BASH_VERSINFO[0]} -ge 4 && \"\$COMP_WORDBREAKS\" == *:*)" 29 | completion+="\n )" 30 | completion+="\n ]]; then" 31 | completion+="\n # Remove colon-word prefix from COMPREPLY items" 32 | completion+="\n local colon_word=\${1%\${1##*:}}" 33 | completion+="\n local i=\${#COMPREPLY[*]}" 34 | completion+="\n while [ \$((--i)) -ge 0 ]; do" 35 | completion+="\n COMPREPLY[\$i]=\${COMPREPLY[\$i]#\"\$colon_word\"}" 36 | completion+="\n done" 37 | completion+="\n fi" 38 | completion+="\n }" 39 | completion+="\nfi" 40 | completion+="\n" 41 | completion+="\n_sfdx()" 42 | completion+="\n{" 43 | completion+="\n local cur" 44 | completion+="\n local prev" 45 | completion+="\n" 46 | completion+="\n cur=\"\${COMP_WORDS[COMP_CWORD]}\"" 47 | completion+="\n prev=\"\${COMP_WORDS[COMP_CWORD-1]}\"" 48 | completion+="\n" 49 | completion+="\n local -a words=(" 50 | # generate list of commands 51 | while read name 52 | do 53 | completion+="\n $name \\ " 54 | done <<< "$(jq -r 'to_entries[] | "\(.value.name)"' commands-list.json)" 55 | 56 | completion+="\n plugins:install \\ " 57 | completion+="\n plugins:link \\ " 58 | completion+="\n plugins:install \\ " 59 | completion+="\n plugins:uninstall \\ " 60 | completion+="\n plugins:update \\ " 61 | completion+="\n update" 62 | 63 | completion+="\n )" 64 | completion+="\n" 65 | completion+="\n case \"\$prev\" in" 66 | completion+="\n sfdx)" 67 | completion+="\n COMPREPLY=( \$(compgen -W \"\${words[*]}\" -- \$cur))" 68 | completion+="\n __ltrim_colon_completions \"\$cur\"" 69 | completion+="\n ;;" 70 | completion+="\n *)" 71 | completion+="\n # return to normal completion" 72 | completion+="\n COMPREPLY=()" 73 | completion+="\n ;;" 74 | completion+="\n esac" 75 | completion+="\n" 76 | completion+="\n return 0" 77 | completion+="\n}" 78 | completion+="\n" 79 | completion+="\ncomplete -o default -F _sfdx sfdx" 80 | 81 | echo "$completion" > sfdx.bash -------------------------------------------------------------------------------- /sfdx.bash: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # DESCRIPTION: Bash completion script for the Salesforce CLI 4 | # AUTHOR: Wade Wegner (@WadeWegner) 5 | # REPO: https://github.com/wadewegner/salesforce-cli-bash-completion 6 | # LICENSE: https://github.com/wadewegner/salesforce-cli-bash-completion/blob/master/LICENSE 7 | 8 | if ! type __ltrim_colon_completions >/dev/null 2>&1; then 9 | # Copyright © 2006-2008, Ian Macdonald 10 | # © 2009-2017, Bash Completion Maintainers 11 | __ltrim_colon_completions() { 12 | # If word-to-complete contains a colon, 13 | # and bash-version < 4, 14 | # or bash-version >= 4 and COMP_WORDBREAKS contains a colon 15 | if [[ 16 | "$1" == *:* && ( 17 | ${BASH_VERSINFO[0]} -lt 4 || 18 | (${BASH_VERSINFO[0]} -ge 4 && "$COMP_WORDBREAKS" == *:*) 19 | ) 20 | ]]; then 21 | # Remove colon-word prefix from COMPREPLY items 22 | local colon_word=${1%${1##*:}} 23 | local i=${#COMPREPLY[*]} 24 | while [ $((--i)) -ge 0 ]; do 25 | COMPREPLY[$i]=${COMPREPLY[$i]#"$colon_word"} 26 | done 27 | fi 28 | } 29 | fi 30 | 31 | _sfdx() 32 | { 33 | local cur 34 | local prev 35 | 36 | cur="${COMP_WORDS[COMP_CWORD]}" 37 | prev="${COMP_WORDS[COMP_CWORD-1]}" 38 | 39 | local -a words=( 40 | force:alias:list \ 41 | force:alias:set \ 42 | force:apex:class:create \ 43 | force:apex:execute \ 44 | force:apex:log:get \ 45 | force:apex:log:list \ 46 | force:apex:log:tail \ 47 | force:apex:test:report \ 48 | force:apex:test:run \ 49 | force:apex:trigger:create \ 50 | force:auth:device:login \ 51 | force:auth:jwt:grant \ 52 | force:auth:list \ 53 | force:auth:logout \ 54 | force:auth:sfdxurl:store \ 55 | force:auth:web:login \ 56 | force:config:get \ 57 | force:config:list \ 58 | force:config:set \ 59 | force:data:bulk:delete \ 60 | force:data:bulk:status \ 61 | force:data:bulk:upsert \ 62 | force:data:record:create \ 63 | force:data:record:delete \ 64 | force:data:record:get \ 65 | force:data:record:update \ 66 | force:data:soql:query \ 67 | force:data:tree:export \ 68 | force:data:tree:import \ 69 | force:doc:commands:display \ 70 | force:doc:commands:list \ 71 | force:lightning:app:create \ 72 | force:lightning:component:create \ 73 | force:lightning:event:create \ 74 | force:lightning:interface:create \ 75 | force:lightning:lint \ 76 | force:lightning:test:create \ 77 | force:lightning:test:install \ 78 | force:lightning:test:run \ 79 | force:limits:api:display \ 80 | force:mdapi:convert \ 81 | force:mdapi:deploy \ 82 | force:mdapi:deploy:cancel \ 83 | force:mdapi:deploy:report \ 84 | force:mdapi:describemetadata \ 85 | force:mdapi:listmetadata \ 86 | force:mdapi:retrieve \ 87 | force:mdapi:retrieve:report \ 88 | force:org:clone \ 89 | force:org:create \ 90 | force:org:delete \ 91 | force:org:display \ 92 | force:org:list \ 93 | force:org:open \ 94 | force:org:shape:create \ 95 | force:org:shape:delete \ 96 | force:org:shape:list \ 97 | force:org:snapshot:create \ 98 | force:org:snapshot:delete \ 99 | force:org:snapshot:get \ 100 | force:org:snapshot:list \ 101 | force:org:status \ 102 | force:package1:version:create \ 103 | force:package1:version:create:get \ 104 | force:package1:version:display \ 105 | force:package1:version:list \ 106 | force:package:create \ 107 | force:package:hammertest:list \ 108 | force:package:hammertest:report \ 109 | force:package:hammertest:run \ 110 | force:package:install \ 111 | force:package:install:report \ 112 | force:package:installed:list \ 113 | force:package:list \ 114 | force:package:uninstall \ 115 | force:package:uninstall:report \ 116 | force:package:update \ 117 | force:package:version:create \ 118 | force:package:version:create:list \ 119 | force:package:version:create:report \ 120 | force:package:version:list \ 121 | force:package:version:promote \ 122 | force:package:version:report \ 123 | force:package:version:update \ 124 | force:project:create \ 125 | force:project:upgrade \ 126 | force:schema:sobject:describe \ 127 | force:schema:sobject:list \ 128 | force:source:convert \ 129 | force:source:delete \ 130 | force:source:deploy \ 131 | force:source:deploy:cancel \ 132 | force:source:deploy:report \ 133 | force:source:open \ 134 | force:source:pull \ 135 | force:source:push \ 136 | force:source:retrieve \ 137 | force:source:status \ 138 | force:user:create \ 139 | force:user:display \ 140 | force:user:list \ 141 | force:user:password:generate \ 142 | force:user:permset:assign \ 143 | force:visualforce:component:create \ 144 | force:visualforce:page:create \ 145 | plugins:install \ 146 | plugins:link \ 147 | plugins:install \ 148 | plugins:uninstall \ 149 | plugins:update \ 150 | update 151 | ) 152 | 153 | case "$prev" in 154 | sfdx) 155 | COMPREPLY=( $(compgen -W "${words[*]}" -- $cur)) 156 | __ltrim_colon_completions "$cur" 157 | ;; 158 | *) 159 | # return to normal completion 160 | COMPREPLY=() 161 | ;; 162 | esac 163 | 164 | return 0 165 | } 166 | 167 | complete -o default -F _sfdx sfdx 168 | --------------------------------------------------------------------------------