├── LICENSE ├── README.md ├── cecho.sh ├── screenshot.gif ├── screenshot.png └── screenshot2.png /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cecho # 2 | 3 | Colorful `echo` for unix-like shell ( [**ascii color**](https://en.wikipedia.org/wiki/ANSI_escape_code) only ), decorate your terminal with more colors. 4 | 5 | ---------- 6 | ---------- 7 | 8 | ## Overview ## 9 | 10 | A light, self-adapting wrapper of `echo` with several useful features, makes easy work for changing **foreground**, **background** and **text action** ( highlight, underline, blink ... ). 11 | 12 | Tested in [**zsh**](http://www.zsh.org/) and [**bash**](http://www.gnu.org/software/bash/). 13 | 14 | ## Screenshot ## 15 | 16 | ![screenshot](https://raw.github.com/springlie/cecho/master/screenshot.gif) 17 | 18 | ##### Active ##### 19 | 20 | ![screenshot](https://raw.github.com/springlie/cecho/master/screenshot.png) 21 | 22 | ##### Inactive ##### 23 | 24 | ![screenshot](https://raw.github.com/springlie/cecho/master/screenshot2.png) 25 | 26 | ## Install ## 27 | 28 | Before use `cecho`, simply source it in your `.zshrc` or `.bashrc`, or any shell script you want to colorize: 29 | 30 | source /path/to/cecho.sh 31 | 32 | ## Usage ## 33 | 34 | Support multi-string in one command: 35 | 36 | cecho -color1 message1 [ -color2 message2 ... ] [ -done ] 37 | 38 | Support setting foreground, background and action 39 | 40 | cecho -fg_color -bg_color -action message [...] [ -done ] 41 | 42 | All switches have **two** forms, short for convenience, long for readability. 43 | 44 | The short forms are the abbreviation from the corresponding long forms. 45 | 46 | #### Foreground color arguments ## 47 | 48 | | short | long | 49 | | ----- | ------- | 50 | | -r | -red | 51 | | -g | -green | 52 | | -y | -yellow | 53 | | -b | -blue | 54 | | -p | -purple | 55 | | -c | -cyan | 56 | | -w | -white | 57 | | -gr | -gray | 58 | | -bk | -black | 59 | 60 | #### Background color arguments #### 61 | 62 | | short | long | 63 | | ----- | ------------ | 64 | | -br | -b_red | 65 | | -bg | -b_green | 66 | | -by | -b_yellow | 67 | | -bb | -b_blue | 68 | | -bp | -b_purple | 69 | | -bc | -b_cyan | 70 | | -bw | -b_white | 71 | | -bgr | -b_gray | 72 | | -bbk | -b_black | 73 | 74 | #### Action arguments #### 75 | 76 | | short | long | 77 | | ----- | ------------ | 78 | | -d | -done | 79 | | -hl | -highlight | 80 | | -ul | -underline | 81 | | -re | -reverse | 82 | | -bl | -blink | 83 | | -iv | -invisible | 84 | 85 | #### Escaped character #### 86 | 87 | | short | long | 88 | | ----- | ------------ | 89 | | -B | -blank | 90 | | -t | -tab | 91 | | -n | -newline | 92 | 93 | #### Functional #### 94 | 95 | | short | long | 96 | | ----- | ------------ | 97 | | -h | -help,--help | 98 | 99 | ## Example ## 100 | 101 | ##### set fg to *red*: ##### 102 | 103 | cecho -r "hello world ! " 104 | or 105 | 106 | cecho -red "hello world ! " 107 | 108 | or 109 | 110 | cecho -r hello -B world -B ! 111 | 112 | ##### *blank* & *tab* & *newline* ##### 113 | 114 | cecho -r -t hello -B world -n ! 115 | 116 | ##### set fg to *red*, bg to *yellow*, action to *highlight* and *underline*: ##### 117 | 118 | cecho -r -by -hl "hello world ! " 119 | 120 | ##### set [ *red*, *yellow*, *highlight* & *underline* ] for "hello", [ *cyan*, *red*, *reverse* ] for "world", [ *green*, *black*, *blink* ] for "!" : ##### 121 | 122 | cecho -r -by -hl -ul hello -d -B -c -br -re world -d -B -g -bl ! 123 | 124 | **Please refer to the help file for more examples:** 125 | 126 | `cecho -h` 127 | 128 | [**That colorful help page**](https://github.com/springlie/cecho#screenshot) is generated by `cecho` . 129 | 130 | ## Useful Variables ## 131 | 132 | #### CECHO_IS_IMPORTED #### 133 | 134 | Once you have sourced `cecho`, `CECHO_IS_IMPORTED=1` will be defined. 135 | 136 | That meams you can check this var `CECHO_IS_IMPORTED` to confirm if you are in a no_cecho env or not: 137 | 138 | Exp: [**Sence 2**](https://github.com/springlie/cecho#2-my-script-maybe-runs-in-both-no-cecho-env-and-cecho-env/) 139 | 140 | #### CECHO_IS_INACTIVE #### 141 | 142 | If you want to deactive `cecho` temporarily, set `CECHO_IS_INACTIVE=1` before calling `cecho`. 143 | 144 | **Note**: color and action can be disabled by `CECHO_IS_INACTIVE`, but `return`, `blank` and `tab` are still active, as you wish. 145 | 146 | ## Sence ## 147 | 148 | ##### 1 - I want my script outputs to file/pipe without color_ctrl chars ##### 149 | 150 | No need to do any change, `cecho` can self-adapt this: colorful for stdout, non-colorful for file/pipe. 151 | 152 | ##### 2 - My script maybe runs in both "no-cecho env" and "cecho env" ##### 153 | 154 | Don't be disappointed, you only need to modify your script like this: 155 | 156 | if [ -z "$CECHO_IS_IMPORTED" ] 157 | then 158 | echo hello world 159 | else 160 | cecho -r -bg -hl hello -B world 161 | fi 162 | 163 | Or shortly: 164 | 165 | [ -z "$CECHO_IS_IMPORTED" ] && echo "hello world" || cecho -r -bg -hl hello -B world 166 | 167 | ##### 3 - My script uses `cecho` but I want to disable it temporarily ##### 168 | 169 | CECHO_IS_INACTIVE=1 170 | cecho -r -bg -hl hello world # <-- now cecho is inactive 171 | CECHO_IS_INACTIVE= 172 | cecho -r -bg -hl hello world # <-- now cecho is active 173 | 174 | ## Advanced ## 175 | 176 | - Action flag `-d` ( same as `-done` ) will turn off all settings ( fg, bg and action ), Thus, in **single** command, you have to set flags again to retrive it back once there are other strings after `-d`. 177 | - Some special characters ( with centain format ) don't work properly, such as `cecho "!"`. It's due to `echo`... use `cecho '!'` or `cecho !` instead. 178 | - It's **not** necessary to use `-d` at the begin/end of commands, `cecho` will take care of it. 179 | - Actions can overlaied. 180 | 181 | ## What's more ## 182 | 183 | Another **C version** project is [**coprintf**](https://github.com/springlie/coprintf). 184 | -------------------------------------------------------------------------------- /cecho.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # source me in your script or .bashrc/.zshrc if wanna use cecho 4 | # source '/path/to/cecho.sh' 5 | 6 | # check this var to detect "cecho" being imported 7 | CECHO_IS_IMPORTED=1 8 | 9 | cecho() 10 | { 11 | #FOREGROUND 12 | 13 | local FG_BLACK="\e[30m" 14 | local FG_RED="\e[31m" 15 | local FG_GREEN="\e[32m" 16 | local FG_YELLOW="\e[33m" 17 | local FG_BLUE="\e[34m" 18 | local FG_PURPLE="\e[35m" 19 | local FG_CYAN="\e[36m" 20 | local FG_WHITE="\e[37m" 21 | 22 | #BACKGROUND 23 | 24 | local BG_BLACK="\e[40m" 25 | local BG_RED="\e[41m" 26 | local BG_GREEN="\e[42m" 27 | local BG_YELLOW="\e[43m" 28 | local BG_BLUE="\e[44m" 29 | local BG_PURPLE="\e[45m" 30 | local BG_CYAN="\e[46m" 31 | local BG_WHITE="\e[47m" 32 | 33 | #ACTION 34 | 35 | local DONE="\e[0m" 36 | local HIGHLIGHT="\e[1m" 37 | local UNDERLINE="\e[4m" 38 | local BLINK="\e[5m" 39 | local REVERSE="\e[7m" 40 | local INVISIBLE="\e[8m" 41 | 42 | # for Bash compatibility 43 | 44 | local WS="\\ " 45 | 46 | # for self-adapting: inactive if output is pipe/file, active if screen 47 | 48 | local CECHO_IS_INACTIVE_INTL=$CECHO_IS_INACTIVE 49 | if [ ! -t 1 ] 50 | then 51 | CECHO_IS_INACTIVE_INTL=1 52 | fi 53 | 54 | # for keeping format when inactive 55 | 56 | local IS_NEED_BLANK= 57 | local INTL_SINGLE_BLANK= 58 | 59 | # other 60 | 61 | local msg= 62 | 63 | local version_info='cecho \ 64 | cecho -B 0.21 -B "" -n \ 65 | Written -B by -B Springlie -B ""' 66 | 67 | local help_info='cecho \ 68 | -r -hl -re -t -t -t -t "the page is generated by" -B -bl "cecho" -d -r -hl -re -t -t -t -t -d -n \ 69 | -hl Usage: -d -n \ 70 | -t "a light and simple wrapper of echo, with colour flags." -d -n -n \ 71 | -hl Syntax: -d -n \ 72 | -t -g -hl cecho -d -B -y -color1 -B -b message1 -w -B "[ -color2 message2 ... ]" -r -B "[ -done ]" -d -n \ 73 | -t -g -hl cecho -d -B -y -fg_color -B -p -bg_color -B -c -action -B -b message -B -w "[...]" -B -r "[ -done ]" -d -n -n \ 74 | -hl "ForeGround color flag:" -d -n \ 75 | -t -r "-r | -red" -t -g "-g | -green" -t -y "-y | -yellow" -t -bk -bw "-bk | -black" -d "(here with white bg)" -d -n \ 76 | -t -b "-b | -blue" -t -p "-p | -purple" -t -c "-c | -cyan" -t -w "-w | -gr | -white | -gray" -d -n -n \ 77 | -hl "BackGround color flag:" -d -n \ 78 | -t -br "-br | -b_red" -t -bg "-bg | -b_green" -t -by "-by | -b_yellow" -t -bbk "-bbk | -b_black" -d -n \ 79 | -t -bb "-bb | -b_blue" -t -bp "-bp | -b_purple" -t -bc "-bc | -b_cyan" -t -bw "-bw | -bgr | -b_white | -b_gray" -d -n -n \ 80 | -hl "Action flag:" -d -n \ 81 | -t "-d | -done" -t -hl "-hl | -highlight" -d -t -ul "-ul | -underline" -d -t -re "-re | -reverse" -d -n \ 82 | -t -bl "-bl | -blink" -d -t "[ there is invisible here ]" -t "-->" -iv "-iv | -invisible" -d "<--" -n -n \ 83 | -hl "Escaped character:" -d -n \ 84 | -t "-B | -blank" -t "-t | -tab" -t "-n | -newline" -d -n \ 85 | -g -hl -re -t -t -t -t "the src of above (as an example)" -t -t -t -d' 86 | 87 | # main looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooop 88 | 89 | while (($#!=0)) 90 | do 91 | 92 | # set internal single blank(avoid duplicate blanks in inactive mode) 93 | 94 | if [ -z $IS_NEED_BLANK ] 95 | then 96 | INTL_SINGLE_BLANK="" 97 | else 98 | INTL_SINGLE_BLANK=" " 99 | fi 100 | 101 | IS_NEED_BLANK= 102 | 103 | 104 | # switch 105 | 106 | case $1 in 107 | 108 | # escape character 109 | 110 | -B|-blank |$WS-B|$WS-blank )msg+=" " ; ;; 111 | -t|-tab |$WS-t|$WS-tab )msg+="\t"; ;; 112 | -n|-newline|$WS-n|$WS-newline)msg+="\n"; ;; 113 | 114 | # foreground color 115 | 116 | -bk|-black |$WS-bk|$WS-black )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_BLACK || echo $INTL_SINGLE_BLANK); ;; 117 | -r |-red |$WS-r |$WS-red )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_RED || echo $INTL_SINGLE_BLANK); ;; 118 | -g |-green |$WS-g |$WS-green )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_GREEN || echo $INTL_SINGLE_BLANK); ;; 119 | -y |-yellow|$WS-y |$WS-yellow )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_YELLOW|| echo $INTL_SINGLE_BLANK); ;; 120 | -b |-blue |$WS-b |$WS-blue )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_BLUE || echo $INTL_SINGLE_BLANK); ;; 121 | -p |-purple|$WS-p |$WS-purple )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_PURPLE|| echo $INTL_SINGLE_BLANK); ;; 122 | -c |-cyan |$WS-c |$WS-cyan )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_CYAN || echo $INTL_SINGLE_BLANK); ;; 123 | -w |-white |$WS-w |$WS-white )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_WHITE || echo $INTL_SINGLE_BLANK); ;; 124 | -gr|-gray |$WS-gr|$WS-gray )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $FG_WHITE || echo $INTL_SINGLE_BLANK); ;; 125 | 126 | # background color 127 | 128 | -bbk|-b_black |$WS-bbk|$WS-b_black )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_BLACK || echo $INTL_SINGLE_BLANK); ;; 129 | -br |-b_red |$WS-br |$WS-b_red )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_RED || echo $INTL_SINGLE_BLANK); ;; 130 | -bg |-b_green |$WS-bg |$WS-b_green )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_GREEN || echo $INTL_SINGLE_BLANK); ;; 131 | -by |-b_yellow|$WS-by |$WS-b_yellow)msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_YELLOW|| echo $INTL_SINGLE_BLANK); ;; 132 | -bb |-b_blue |$WS-bb |$WS-b_blue )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_BLUE || echo $INTL_SINGLE_BLANK); ;; 133 | -bp |-b_purple|$WS-bp |$WS-b_purple)msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_PURPLE|| echo $INTL_SINGLE_BLANK); ;; 134 | -bc |-b_cyan |$WS-bc |$WS-b_cyan )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_CYAN || echo $INTL_SINGLE_BLANK); ;; 135 | -bw |-b_white |$WS-bw |$WS-b_white )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_WHITE || echo $INTL_SINGLE_BLANK); ;; 136 | -bgr|-b_gray |$WS-bgr|$WS-b_gray )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BG_WHITE || echo $INTL_SINGLE_BLANK); ;; 137 | 138 | # action, some can be overlaid 139 | 140 | -d |-done |$WS-d |$WS-done )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $DONE || echo $INTL_SINGLE_BLANK); ;; 141 | -hl|-highlight|$WS-hl|$WS-highlight)msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $HIGHLIGHT|| echo $INTL_SINGLE_BLANK); ;; 142 | -ul|-underline|$WS-ul|$WS-underline)msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $UNDERLINE|| echo $INTL_SINGLE_BLANK); ;; 143 | -bl|-blink |$WS-bl|$WS-blink )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $BLINK || echo $INTL_SINGLE_BLANK); ;; 144 | -re|-reverse |$WS-re|$WS-reverse )msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $REVERSE || echo $INTL_SINGLE_BLANK); ;; 145 | -iv|-invisible|$WS-iv|$WS-invisible)msg+=$([ -z $CECHO_IS_INACTIVE_INTL ] && echo $INVISIBLE|| echo $INTL_SINGLE_BLANK); ;; 146 | 147 | # functional 148 | 149 | -v|-version|--version|$WS-v|$WS-version|$WS--version) 150 | eval $version_info 151 | return 0 152 | ;; 153 | 154 | -h|-help|--help|$WS-h|$WS-help|$WS--help) 155 | eval $help_info 156 | 157 | if [ $0 "==" "bash" ] 158 | then 159 | echo $help_info | sed -r 's/\\/\\\n/g' 160 | else 161 | echo $help_info 162 | fi 163 | 164 | return 0 165 | ;; 166 | 167 | # string 168 | 169 | *) 170 | msg=$msg$1 171 | 172 | # reset 173 | 174 | IS_NEED_BLANK=1 175 | ;; 176 | 177 | esac 178 | shift 179 | done 180 | 181 | # clear 182 | 183 | msg=$DONE$msg$DONE 184 | 185 | # print 186 | 187 | echo -e $msg 188 | } 189 | 190 | -------------------------------------------------------------------------------- /screenshot.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/springlie/cecho/d37eadd0ab0ff757ffc05142c5b4d7b0da0dc734/screenshot.gif -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/springlie/cecho/d37eadd0ab0ff757ffc05142c5b4d7b0da0dc734/screenshot.png -------------------------------------------------------------------------------- /screenshot2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/springlie/cecho/d37eadd0ab0ff757ffc05142c5b4d7b0da0dc734/screenshot2.png --------------------------------------------------------------------------------