Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/watchexec/watchexec

Executes commands in response to file modifications
https://github.com/watchexec/watchexec

command-line developer-tools file-watchers linux macos rust windows

Last synced: about 2 months ago
JSON representation

Executes commands in response to file modifications

Awesome Lists containing this project

README 

        
[![CI status on main branch](https://github.com/watchexec/watchexec/actions/workflows/tests.yml/badge.svg)](https://github.com/watchexec/watchexec/actions/workflows/tests.yml)



# Watchexec



Software development often involves running the same commands over and over. Boring!



`watchexec` is 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

* Rebuild artifacts



## Features



* Simple invocation and use, does not require a cryptic command line involving `xargs`

* Runs on OS X, Linux, and Windows

* Monitors current directory and all subdirectories for changes

* Coalesces multiple filesystem events into one, for editors that use swap/backup files during saving

* Loads `.gitignore` and `.ignore` files

* Uses process groups to keep hold of forking programs

* Provides the paths that changed in environment variables or STDIN

* Does not require a language runtime, not tied to any particular language or ecosystem

* [And more!](./crates/cli/#features)



## Quick start



Watch all JavaScript, CSS and HTML files in the current directory and all subdirectories for changes, running `npm run build` when a change is detected:



    $ watchexec -e js,css,html npm run build



Call/restart `python server.py` when any Python file in the current directory (and all subdirectories) changes:



    $ watchexec -r -e py -- python server.py



More usage examples: [in the CLI README](./crates/cli/#usage-examples)!



## Install



Packaging status



- With [your package manager](./doc/packages.md) for Arch, Debian, Homebrew, Nix, Scoop, Chocolatey…

- From binary with [Binstall](https://github.com/cargo-bins/cargo-binstall): `cargo binstall watchexec-cli`

- As [pre-built binary package from Github](https://github.com/watchexec/watchexec/releases/latest)

- From source with Cargo: `cargo install --locked watchexec-cli`



All options in detail: [in the CLI README](./crates/cli/#installation),

in the online help (`watchexec -h`, `watchexec --help`, or `watchexec --manual`),

and [in the manual page](./doc/watchexec.1.md).



## Augment



Watchexec pairs well with:



- [checkexec](https://github.com/kurtbuilds/checkexec): to run only when source files are newer than a target file

- [just](https://github.com/casey/just): a modern alternative to `make`

- [systemfd](https://github.com/mitsuhiko/systemfd): socket-passing in development



## Extend



- [watchexec library](./crates/lib/): to create more specialised watchexec-powered tools.

  - [watchexec-events](./crates/events/): event types for watchexec.

  - [watchexec-signals](./crates/signals/): signal types for watchexec.

  - [watchexec-supervisor](./crates/supervisor/): process lifecycle manager (the _exec_ part of watchexec).

- [clearscreen](https://github.com/watchexec/clearscreen): to clear the (terminal) screen on every platform.

- [command group](https://github.com/watchexec/command-group): to run commands in process groups.

- [ignore files](./crates/ignore-files/): to find, parse, and interpret ignore files.

- [project origins](./crates/project-origins/): to find the origin(s) directory of a project.

- [notify](https://github.com/notify-rs/notify): to respond to file modifications (third-party).



### Downstreams



Selected downstreams of watchexec and associated crates:



- [cargo watch](https://github.com/watchexec/cargo-watch): a specialised watcher for Rust/Cargo projects.

- [cargo lambda](https://github.com/cargo-lambda/cargo-lambda): a dev tool for Rust-powered AWS Lambda functions.

- [create-rust-app](https://create-rust-app.dev): a template for Rust+React web apps.

- [dotter](https://github.com/supercuber/dotter): a dotfile manager.

- [ghciwatch](https://github.com/mercurytechnologies/ghciwatch): a specialised watcher for Haskell projects.

- [tectonic](https://tectonic-typesetting.github.io/book/latest/): a TeX/LaTeX typesetting system.