https://github.com/jichu4n/bash-command-timer

Bash extension for printing execution time for each command.
https://github.com/jichu4n/bash-command-timer

Last synced: 3 months ago
JSON representation

Bash extension for printing execution time for each command.

• Host: GitHub
• URL: https://github.com/jichu4n/bash-command-timer
• Owner: jichu4n
• License: apache-2.0
• Created: 2014-06-09T02:36:21.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-09-30T00:05:52.000Z (about 4 years ago)
• Last Synced: 2024-02-13T21:59:35.822Z (9 months ago)
• Language: Shell
• Homepage:
• Size: 66.4 KB
• Stars: 89
• Watchers: 6
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
bash-command-timer

==================

Bash extension for printing timing information for each command line

executed.

Usage

-----

After the execution of each command line, the script prints out the total

execution time (up to millisecond precision), followed by the current time. The

execution time is formatted to be human readable; e.g., `2h 7m 42s301`.

Demo:

![Demo Screen-cap](https://github.com/jichu4n/bash-command-timer/raw/master/bash_command_timer_screenshot.gif)

Requirements

------------

This script should run pretty much out of the box on modern Linux and Mac OS X

systems. Please report any incompatibilities on

[on GitHub](https://github.com/jichu4n/bash-command-timer/issues).

Note that by default, this script will conflict with any other script that uses the

DEBUG trap and `PROMPT_COMMAND`. However, if 

[`bash-preexec`](https://github.com/rcaloras/bash-preexec) is detected on your 

system, then it will be used to maintain compatibility with other scripts using

`bash-preexec`.

Installation

------------

To set up this extension, you can

1. Download `bash_command_timer.sh` somewhere, and add the following to your

   `~/.bashrc` (replace with actual path where you saved the script):

   ```bash

   source ~/.bash_command_timer.sh

   ```

2. Alternatively, you can simply copy and paste the contents of

   `bash_command_timer.sh` into your `~/.bashrc`.

That's it :)

Settings

--------

You can use the following options to tweak the behavior of the script. You can

either make the changes in-place (at the top of the script) or put them after

sourcing the script in your `.bashrc`. You can also modify them on-the-fly if

you want the changes to only affect your current Bash session.

* `BCT_ENABLE=1`: Setting this to 0 disables the printing of timings.

* `BCT_COLOR='34'`: The color of the output. This should be a color string

  usable in a VT100 escape sequence (see

  [Wikipedia](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors)), without

  the escape sequence prefix and suffix. For example, bold red would be

  `'1;31'`.

* `BCT_TIME_FORMAT='%b %d %I:%M%p'`: The display format of the current time.

  This is a strftime format string (see http://strftime.org/). If empty, the

  current time will not be printed.

* `BCT_MILLIS=1`: Whether to print timings to millisecond precision. If set to

  zero, will print timings up to seconds.

* `BASH_PREEXEC_LOCATION='/usr/share/bash-preexec/bash-preexec.sh'`: If 

  `bash-preexec` is installed in a non-standard location, you can set its path 

  here

Details

-------

For an explanation of how the script works, you're welcome to check out my blog

post: [DEBUG trap and

PROMPT_COMMAND in Bash](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash.html).