watchexec/crates/cli/README.md

148 lines
5.3 KiB
Markdown
Raw Normal View History

2021-05-08 17:39:13 +02:00
# Watchexec CLI
A simple standalone tool that watches a path and runs a command whenever it detects modifications.
Example use cases:
* Automatically run unit tests
* Run linters/syntax checkers
## Features
* Simple invocation and use
2021-07-21 14:13:59 +02:00
* Runs on Linux, Mac, Windows, and more
2021-05-08 17:39:13 +02:00
* Monitors current directory and all subdirectories for changes
2021-12-29 10:06:50 +01:00
* Uses efficient event polling mechanism (on Linux, Mac, Windows, BSD)
2021-05-08 17:39:13 +02:00
* Coalesces multiple filesystem events into one, for editors that use swap/backup files during saving
2021-12-29 10:06:50 +01:00
* By default, uses `.gitignore`, `.ignore`, and other such files to determine which files to ignore notifications for
2021-05-08 17:39:13 +02:00
* Support for watching files with a specific extension
* Support for filtering/ignoring events based on [glob patterns](https://docs.rs/globset/*/globset/#syntax)
2021-07-21 14:13:59 +02:00
* Launches the command in a new process group (can be disabled with `--no-process-group`)
2021-05-08 17:39:13 +02:00
* Optionally clears screen between executions
* Optionally restarts the command with every modification (good for servers)
* Optionally sends a desktop notification on command start and end
2021-05-08 17:39:13 +02:00
* Does not require a language runtime
2021-12-29 10:06:50 +01:00
* Sets the following environment variables in the process:
`$WATCHEXEC_COMMON_PATH` is set to the longest common path of all of the below variables, and so should be prepended to each path to obtain the full/real path.
| Variable name | Event kind |
|---|---|
| `$WATCHEXEC_CREATED_PATH` | files/folders were created |
| `$WATCHEXEC_REMOVED_PATH` | files/folders were removed |
| `$WATCHEXEC_RENAMED_PATH` | files/folders were renamed |
| `$WATCHEXEC_WRITTEN_PATH` | files/folders were modified |
| `$WATCHEXEC_META_CHANGED_PATH` | files/folders' metadata were modified |
| `$WATCHEXEC_OTHERWISE_CHANGED_PATH` | every other kind of event |
These variables may contain multiple paths: these are separated by the platform's path separator, as with the `PATH` system environment variable. On Unix that is `:`, and on Windows `;`. Within each variable, paths are deduplicated and sorted in binary order (i.e. neither Unicode nor locale aware).
2021-12-29 10:06:50 +01:00
This can be disabled or limited with `--no-environment` (doesn't set any of these variables) and `--no-meta` (ignores metadata changes).
2021-05-08 17:39:13 +02:00
## Anti-Features
* Not tied to any particular language or ecosystem
2021-12-29 10:06:50 +01:00
* Not tied to Git or the presence of a repository/project
2021-05-08 17:39:13 +02:00
* Does not require a cryptic command line involving `xargs`
## Usage Examples
Watch all JavaScript, CSS and HTML files in the current directory and all subdirectories for changes, running `make` when a change is detected:
$ watchexec --exts js,css,html make
Call `make test` when any file changes in this directory/subdirectory, except for everything below `target`:
$ watchexec -i "target/**" make test
2021-05-08 17:39:13 +02:00
Call `ls -la` when any file changes in this directory/subdirectory:
$ watchexec -- ls -la
Call/restart `python server.py` when any Python file in the current directory (and all subdirectories) changes:
$ watchexec -e py -r python server.py
Call/restart `my_server` when any file in the current directory (and all subdirectories) changes, sending `SIGKILL` to stop the command:
$ watchexec -r -s SIGKILL my_server
Send a SIGHUP to the command upon changes (Note: using `-n` here we're executing `my_server` directly, instead of wrapping it in a shell:
$ watchexec -n -s SIGHUP my_server
Run `make` when any file changes, using the `.gitignore` file in the current directory to filter:
$ watchexec make
Run `make` when any file in `lib` or `src` changes:
$ watchexec -w lib -w src make
Run `bundle install` when the `Gemfile` changes:
$ watchexec -w Gemfile bundle install
Run two commands:
$ watchexec 'date; make'
If you come from `entr`, note that the watchexec command is run in a shell by default. You can use `-n` or `--shell=none` to not do that:
$ watchexec -n -- echo ';' lorem ipsum
On Windows, you may prefer to use Powershell:
$ watchexec --shell=powershell -- test-connection localhost
## Installation
2021-07-21 14:13:59 +02:00
### First-party
2021-05-08 17:39:13 +02:00
#### Pre-built
Use the download section on [Github](https://github.com/watchexec/watchexec/releases/latest) or [the website](https://watchexec.github.io/downloads/) to obtain the
2021-07-21 14:13:59 +02:00
package appropriate for your platform and architecture, extract it, and place it in your `PATH`.
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
There are also Debian/Ubuntu (DEB) and Fedora/RedHat (RPM) packages.
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
Checksums and signatures are available.
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
#### Cargo (from source)
2021-05-08 17:39:13 +02:00
Requires Rust 1.58.0 or later.
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
$ cargo install watchexec-cli
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
#### [Binstall](https://github.com/ryankurte/cargo-binstall)
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
$ cargo binstall watchexec-cli
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
### Third-party
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
These are provided by third parties, caveat emptor!
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
#### macOS
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
- Homebrew: `$ brew install watchexec`
- Nix/NixOS: `$ nix-env -iA nixpkgs.watchexec`
- Webi: `$ curl -sS https://webinstall.dev/watchexec | bash`
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
#### Linux
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
- ArchLinux: `$ pacman -S watchexec`
- Nix/NixOS: `$ nix-env -iA nixpkgs.watchexec`
- Webi: `$ curl -sS https://webinstall.dev/watchexec | bash`
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
#### Windows
2021-05-08 17:39:13 +02:00
2021-07-21 14:13:59 +02:00
- Scoop: `#> scoop install watchexec`
- Chocolatey: `#> choco install watchexec`
- Webi: `#> curl.exe -A MS https://webinstall.dev/watchexec | powershell`
2021-05-08 17:39:13 +02:00
## Shell completions
Currently available shell completions:
- zsh: `completions/zsh` should be installed to `/usr/share/zsh/site-functions/_watchexec`