├── .editorconfig ├── LICENSE ├── README.md ├── bash-dash.sh └── commands.sh /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | indent_style = tab 6 | indent_size = 2 7 | end_of_line = lf 8 | insert_final_newline = true 9 | trim_trailing_whitespace = true 10 | quote_type = double 11 | -------------------------------------------------------------------------------- /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 2020 n8n GmbH 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 | # bash-dash (Beta) 2 | 3 | (Slash) Dash commands are commands typed in the command line to run an action. bash-dash is a project created for [n8n.io](https://n8n.io) workflows, but you can use it with anything that can receive HTTP requests. 4 | 5 | ## Installation 6 | 7 | To use bash-dash, you need to have [curl](https://curl.se/) installed. Then, install bash-dash by running: 8 | 9 | ```bash 10 | mkdir ~/.bash-dash && curl https://raw.githubusercontent.com/n8n-io/bash-dash/main/bash-dash.sh -o ~/.bash-dash/bash-dash.sh && chmod 711 ~/.bash-dash/bash-dash.sh && curl https://raw.githubusercontent.com/n8n-io/bash-dash/main/commands.sh -o ~/.bash-dash/commands.sh && echo "alias -- -=~/.bash-dash/bash-dash.sh" >> ~/.bashrc 11 | ``` 12 | 13 | bash-dash requires bash version 4+. Unfortunately does MacOS ship with the outdated bash version 3 (last patch is from 2006). We **highly** recommend upgrading it. 14 | [How to upgrade Bash on MacOS](#Upgrade-Bash-on-MacOS) 15 | 16 | ## Usage 17 | 18 | After installing bash-dash, you can test it and add your own custom commands. 19 | 20 | ### Update command 21 | 22 | We are continuously improving the bash-dash. To update to the latest version, run: 23 | 24 | ``` 25 | - --update 26 | ``` 27 | 28 | ### Call commands 29 | 30 | To call a bash-dash command, type a dash `-` followed by the command you want. 31 | 32 | For example, a `weather` command is invoked like this: 33 | 34 | ```bash 35 | - weather 36 | ``` 37 | 38 | You can supply additional parameters by typing them after the command. For example, to get the weather in Berlin, run: 39 | 40 | ```bash 41 | - weather berlin 42 | ``` 43 | 44 | bash-dash comes with a pre-specified test command. You can try it out by running: 45 | 46 | ```bash 47 | - test 48 | ``` 49 | 50 | ### Custom commands 51 | 52 | You can create custom bash-dash commands for your personal use-cases. To do this, open the file `~/.bash-dash/commands.sh` and add a new line to the `commands` array. There are two possible formats in which you can add new commands, depending on how specific you need them to be: simple format and advanced format. 53 | 54 | #### Simple Format 55 | 56 | Add a new command by specifying the name of your custom command and the URL that should be called when the command is issued. The command will then make a GET request (by default) to that URL. Custom commands in simple format look like this: 57 | 58 | ```bash 59 | commands[command_name]="YOUR_URL" 60 | ``` 61 | 62 | #### Advanced Format 63 | 64 | If you want more control over your custom commands, use the advanced format, which allows you to specify three parameters: 65 | 66 | - URL[required]: The URL that the bash-command should call 67 | - METHOD[optional]: The HTTP Request-Method (default: GET) 68 | - TEST-URL[optional]: The Test-URL to use (default: as described under "Call a test Webhook") 69 | 70 | For example, to add the `test` command, type: 71 | 72 | ```bash 73 | commands[test]="URL:http://localhost:5678/webhook/test|METHOD:GET|TEST-URL:http://localhost:5678/webhook-test/test" 74 | ``` 75 | 76 | ### Response formatting 77 | 78 | You can format how the response gets displayed in the terminal by using backslash escapes `\`. 79 | 80 | For example, to display the word "green" in green color, type: 81 | 82 | ```bash 83 | The following text is \033[32mgreen\033[0m 84 | ``` 85 | 86 | If you use bash-dash with n8n workflows, you can edit the displayed text in the Response node. For example, could the bash-dash-weather workflow display the output like this: 87 | 88 | ![bash-dash getting weather information from the terminal](https://i.imgur.com/1kzrNFl.png) 89 | 90 | You can find the different codes for colors and formatting options (e.g., bold, underline) [here](https://misc.flogisoft.com/bash/tip_colors_and_formatting). 91 | 92 | ### Call a test Webhook 93 | 94 | You can call a test webhook by adding `--test` as the last parameter of a command. The command will then call the URL that was defined as `TEST-URL`. If a test webhook has not been defined, the command will replace `/webhook/` with `/webhook-test/` in the URL. 95 | 96 | ## Examples 97 | 98 | There are many possible use-cases of bash-dash. To give you some ideas, here are some examples of n8n workflows: 99 | 100 | - `- weather berlin` to return the current weather in Berlin. You can find the workflow [here](https://n8n.io/workflows/986). 101 | - `- asana My new task` to create a new task in Asana. You can find the workflow [here](https://n8n.io/workflows/987). 102 | - `- sms wife Will be home late` to send a messge to your partner 103 | - `- serverStats production1` to return server statistics 104 | - `- spotify next` to skip to the next song on Spotify 105 | - `- light` to toggle your IoT light 106 | 107 | ## Backend 108 | 109 | You can use bash-dash with anything that can receive HTTP request calls. 110 | 111 | The requests that bash-dash makes are by default GET-requests. Optional call-commands that are supplied will be sent as query parameters. The server has at least 2 minutes to send a response, which is then printed in the terminal. 112 | 113 | ## Upgrade Bash on MacOS 114 | 115 | Unfortunately MacOS doesn’t provide the latest bash version which may prevent you to take advantage of the latest features that came with bash 4 and 5. Also, running an outdated bash version probably exposes you to some major vulnerabilities. 116 | 117 | MacOS comes with Bash version 3 which is quite limiting and lack key features like the bash associative arrays, improved auto-completion, better Posix conformance, etc. 118 | 119 | Follow these steps to upgrade: 120 | 121 | ### Let's check your version first 122 | 123 | ```bash 124 | $ bash --version 125 | 3.2.53(1)-release 126 | ``` 127 | 128 | ### Install Homebrew if you don't have it yet 129 | 130 | ```bash 131 | $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" 132 | ``` 133 | 134 | ### Install latest bash version 135 | 136 | ```bash 137 | $ brew update && brew install bash 138 | ``` 139 | 140 | ### Add new bash version to $PATH 141 | 142 | If you run: 143 | 144 | ```bash 145 | $ which bash 146 | ``` 147 | 148 | It will show you most likely, `/bin/bash`. You might want to add the new bash to your path by editing the `~/.bashrc` or `~/.bash_profile` files, by adding the following line: 149 | 150 | ```bash 151 | # add to .bash_profile (recommended) or .bashrc 152 | export PATH="/usr/local/bin:$PATH" 153 | ``` 154 | 155 | Now `$ which bash` should give you the Homebrew installation: `/usr/local/bin/bash`. If not, refresh your terminal session or run `$ source ~/.bash_profile` or `$ source ~/.bashrc` and try again. 156 | 157 | ### Configure terminal to use it 158 | 159 | ```bash 160 | $ sudo bash -c 'echo /usr/local/bin/bash >> /etc/shells' 161 | ``` 162 | 163 | if you are using bash as your main shell (you can check via `$ echo $SHELL` if this prints `/bin/bash` you do) you should change to the updated version: 164 | 165 | ```bash 166 | $ chsh -s /usr/local/bin/bash 167 | ``` 168 | 169 | Now close/refresh you terminal session. 170 | 171 | That's it! you can check which bash version you are running via: `$ bash --version` 172 | 173 | ## License 174 | 175 | bash-dash is [**Apache 2.0**](https://github.com/n8n-io/bash-dash/blob/main/LICENSE) licensed. 176 | -------------------------------------------------------------------------------- /bash-dash.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Load the available commands from external file 4 | source ~/.bash-dash/commands.sh 5 | 6 | # If no command got supplied list the available ones 7 | command=$1 8 | if [ -z "$command" ] 9 | then 10 | echo "No command supplied!" 11 | echo 12 | echo "The following commands are supported:" 13 | for i in "${!commands[@]}" 14 | do 15 | echo -e " - \e[1m$i \e[0m(${commands[$i]})" 16 | done 17 | exit 0 18 | fi 19 | 20 | # Update bash-dash 21 | if [ "$command" = "--update" ] 22 | then 23 | echo "Updating bash-dash!" 24 | { 25 | curl --fail --silent --show-error --output ~/.bash-dash/bash-dash.sh https://raw.githubusercontent.com/n8n-io/bash-dash/main/bash-dash.sh 26 | } || { 27 | echo "Update did fail!" 28 | exit 1 29 | } 30 | echo "Success!" 31 | exit 0 32 | fi 33 | 34 | if [ -z "${commands[$command]}" ] 35 | then 36 | echo "The command \"$command\" is not known!" 37 | exit 1 38 | fi 39 | 40 | method=GET 41 | data=${commands[$command]} 42 | 43 | if [[ $data = *"|"* ]]; then 44 | # Command got defined via advanced format 45 | IFS='|' read -r -a array <<< "$data" 46 | 47 | for element in "${array[@]}" 48 | do 49 | if [[ $element = "URL:"* ]]; then 50 | url="${element:4}" 51 | elif [[ $element = "TEST-URL:"* ]]; then 52 | testurl="${element:8}" 53 | elif [[ $element = "METHOD:"* ]]; then 54 | method="${element:7}" 55 | fi 56 | done 57 | 58 | if [ -z "$url" ]; then 59 | echo "There is no URL defined for command \"$command\"!" 60 | exit 1 61 | fi 62 | else 63 | # Command got defined via simple format 64 | url=$data 65 | fi 66 | 67 | if [ "${@: -1}" == "--test" ] 68 | then 69 | echo "*** TEST WEBHOOK ***" 70 | parameter=${*:2:$#-2} 71 | if [ -z "$testurl" ]; then 72 | url="${url/\/webhook\//\/webhook-test\/}" 73 | else 74 | url=$testurl 75 | fi 76 | else 77 | parameter=${*:2} 78 | fi 79 | 80 | if [[ $method = "POST" ]]; then 81 | echo -e "$(curl -s --data-urlencode "command=$command" --data-urlencode "parameter=$parameter" -H "user-agent: bash-dash" -X POST -G $url)" 82 | else 83 | echo -e "$(curl -s --data-urlencode "command=$command" --data-urlencode "parameter=$parameter" -H "user-agent: bash-dash" -G $url)" 84 | fi 85 | echo "" 86 | -------------------------------------------------------------------------------- /commands.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | declare -A commands 4 | 5 | # Commands for bash-dash 6 | commands[test]="http://localhost:5678/webhook/test" 7 | # commands[test]="URL:http://localhost:5678/webhook/test|METHOD:POST|TEST-URL:http://localhost:5678/webhook-test/test" 8 | --------------------------------------------------------------------------------