Cargo Watch watches over your project's source for changes, and runs Cargo commands when they occur.
If you've used [nodemon], [gulp], [guard], [watchman], or similar others, it will probably feel familiar.
$ cargo install cargo-watch
To upgrade:
$ cargo install --force cargo-watch
Or clone and build with $ cargo build then place in your $PATH.
By default, it runs check (which is available since Rust 1.16).
You can easily override this, though:
$ cargo watch [command...]
A few examples:
$ cargo watch test
$ cargo watch run
$ cargo watch doc
$ cargo watch test bench
$ cargo watch "build --release"
$ cargo watch "build --release" "test test_"
~~Cargo Watch has special behaviour with run commands: it will restart the
process on file change. This works especially well when developing servers
or other applications that never return on normal operation.~~
⚠ This currently doesn't work properly, see #25. ⚠
As a result of this long-standing issue (a contributed fix would be immensely appreciated, but I'll get to it eventually), if you're developing servers it's probably better to use an alternative, like [nodemon] if you have Node, or [watchexec] if you like Rust tooling.
It pairs well with [dybuk], the compiler output prettifier:
$ cargo watch |& dybuk
Just like any Cargo command, it will run from any project subdirectory.
Cargo Watch will ignore everything that's not a Rust file, and files that start
with either a dot (.foo.rs) or a tilde (~foo.rs).
It uses the [notify] crate for file events, so it supports all platforms, some more efficiently than others (if you use the big three — Linux, Mac, Windows — you will be fine).
If your Cargo Watch fails to watch some deep directories but not others, and you are on Linux, you may have hit the inotify watch limit. You can either increase the limit (instructions are on the previous link and at this Guard wiki page), or you can stop whatever it is that's consuming so many inotify watches.
It does not yet support Cargo workspaces.
Created by Félix Saparelli and awesome contributors.