= `just`
:toc: macro
:toc-title:
image:https://img.shields.io/crates/v/just.svg[crates.io version,link=https://crates.io/crates/just]
image:https://travis-ci.org/casey/just.svg?branch=master[build status,link=https://travis-ci.org/casey/just]
image:https://badges.gitter.im/just-because/Lobby.svg[chat on gitter,link=https://gitter.im/just-because/Lobby]
image:https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg[say thanks,link=https://saythanks.io/to/casey]
`just` is a handy way to save and run project-specific commands.
Commands are stored in a file called `justfile` or `Justfile` with syntax inspired by `make`:
```make
build:
cc *.c -o main
# test everything
test-all: build
./test --all
# run a specific test
test TEST: build
./test --test {{TEST}}
```
`just` produces detailed error messages and avoids `make`’s idiosyncrasies, so debugging a justfile is easier and less surprising than debugging a makefile.
If you need help with `just` please feel free to open an issue or let me know on link:https://gitter.im/just-because/Lobby[gitter]. Feature requests and bug reports are always welcome!
[discrete]
== Manual
toc::[]
== Installation
`just` should run on any system with a reasonable `sh`.
On Windows, you'll need to install https://git-scm.com[git] or https://desktop.github.com[GitHub Desktop].
=== Cargo
`just` can be installed using `cargo`, the https://www.rust-lang.org[rust language package manager]:
1. Install rust and cargo by following the instructions https://www.rustup.rs[here]
2. Run `cargo install just`
3. Add `~/.cargo/bin` to your shell's $PATH.
`rustup` may have done #3 for you. If this doesn't work, put `export PATH="$HOME/.cargo/bin:$PATH"` in your shell's configuration file
=== Homebrew
On MacOS, `just` is a available through the https://brew.sh[Homebrew] package manager. Install Homebrew using the instructions at https://brew.sh, then run:
`brew install just`
=== Pre-built Binaries
Pre-built binaries for Linux, macOS, and Windows can be found on https://github.com/casey/just/releases[the releases page].
== Quick Start
See xref:Installation[] for how to install `just` on your computer. Try running `just --version` to make sure that it's installed correctly.
Once `just` is installed and working, create a file named `justfile` in the root of your project with the following contents:
```make
recipe-name:
echo 'This is a recipe!'
# this is a comment
another-recipe:
@echo 'This is another recipe.'
```
When you invoke `just` it looks for a `justfile` in the current directory and upwards, so you can invoke it from any subdirectory of your project.
Running `just` with no arguments runs the first recipe in the `justfile`:
```sh
$ just
echo 'This is a recipe!'
This is a recipe!
```
One or more arguments specify the recipe(s) to run:
```sh
$ just another-recipe
Another recipe.
```
`just` prints each command to standard error before running it, which is why `echo 'This is a recipe!'` was printed. This is suppressed for lines starting with `@`, which is why `echo 'Another recipe.'` was not printed.
Recipes stop running if a command fails. Here `cargo publish` will only run if `cargo test` succeeds:
```make
publish:
cargo test
# tests passed, time to publish!
cargo publish
```
Recipes can depend on other recipes. Here the `test` recipe depends on the `build` recipe, so `build` will run before `test`:
```make
build:
cc main.c foo.c bar.c -o main
test: build
./test
sloc:
@echo "`wc -l *.c` lines of code"
```
```sh
$ just test
cc main.c foo.c bar.c -o main
./test
testing... all tests passed!
```
Recipes without dependencies will run in the order they're given on the command line:
```sh
$ just build sloc
cc main.c foo.c bar.c -o main
1337 lines of code
```
Dependencies will always run first, even if they are passed after a recipe that depends on them:
```sh
$ just test build
cc main.c foo.c bar.c -o main
./test
testing... all tests passed!
```
== Features
=== Listing Available Recipes
Recipes can be listed with `just --list` :
```sh
$ just --list
Available recipes:
build
test
deploy
lint
```
`just --summary` is more concise:
```sh
$ just --summary
build test deploy lint
```
=== Documentation Comments
Comments immediately preceding a recipe will appear in `just --list`:
```make
# build stuff
build:
./bin/build
# test stuff
test:
./bin/test
```
```sh
$ just --list
Available recipes:
build # build stuff
test # test stuff
```
=== Variables and Substitution
Variables, strings, concatenation, and substitution using `{{...}}` are supported:
```make
version = "0.2.7"
tardir = "awesomesauce-" + version
tarball = tardir + ".tar.gz"
publish:
rm -f {{tarball}}
mkdir {{tardir}}
cp README.md *.c {{tardir}}
tar zcvf {{tarball}} {{tardir}}
scp {{tarball}} me@server.com:release/
rm -rf {{tarball}} {{tardir}}
```
=== Strings
Double-quoted strings support escape sequences:
```make
string-with-tab = "\t"
string-with-newline = "\n"
string-with-carriage-return = "\r"
string-with-double-quote = "\""
string-with-slash = "\\"
```
```sh
$ just --evaluate
"tring-with-carriage-return = "
string-with-double-quote = """
string-with-newline = "
"
string-with-slash = "\"
string-with-tab = " "
```
Single-quoted strings do not recognize escape sequences and may contain line breaks:
```make
escapes = '\t\n\r\"\\'
line-breaks = 'hello
this
is
a
raw
string!
'
```
```sh
$ just --evaluate
escapes = "\t\n\r\"\\"
line-breaks = "hello
this
is
a
raw
string!
"
```
=== Command Evaluation using Backticks
Backticks can be used to store the result of commands:
```make
localhost = `dumpinterfaces | cut -d: -f2 | sed 's/\/.*//' | sed 's/ //g'`
serve:
./serve {{localhost}} 8080
```
=== Setting Variables from the Command Line
Variables can be overridden from the command line.
```make
os = "linux"
test: build
./test --test {{os}}
build:
./build {{os}}
```
```sh
$ just
./build linux
./test --test linux
```
Any number of arguments of the form `NAME=VALUE` can be passed before recipes:
```sh
$ just os=plan9
./build plan9
./test --test plan9
```
Or you can use the `--set` flag:
```sh
$ just --set os bsd
./build bsd
./test --test bsd
```
=== Environment Variables
Assignments prefixed with the `export` keyword will be exported to recipes as environment variables:
```make
export RUST_BACKTRACE = "1"
test:
# will print a stack trace if it crashes
cargo test
```
=== Recipe Parameters
Recipes may have parameters. Here recipe `build` has a parameter called `target`:
```make
build target:
@echo 'Building {{target}}...'
cd {{target}} && make
```
Other recipes may not depend on a recipe with parameters.
To pass arguments, put them after the recipe name:
```sh
$ just build my-awesome-project
Building my-awesome-project...
cd my-awesome-project && make
```
Parameters may have default values:
```make
test target tests='all':
@echo 'Testing {{target}}:{{tests}}...'
./test --tests {{tests}} {{target}}
```
Parameters with default values may be omitted:
```sh
$ just test server
Testing server:all...
./test --tests all server
```
Or supplied:
```sh
$ just test server unit
Testing server:unit...
./test --tests unit server
```
The last parameter of a recipe may be variadic, indicated with a `+` before the argument name:
```make
backup +FILES:
scp {{FILES}} me@server.com:
```
Variadic parameters accept one or more arguments and expand to a string containing those arguments separated by spaces:
```sh
$ just backup FAQ.md GRAMMAR.md
scp FAQ.md GRAMMAR.md me@server.com:
FAQ.md 100% 1831 1.8KB/s 00:00
GRAMMAR.md 100% 1666 1.6KB/s 00:00
```
`{{...}}` substitutions may need to be quoted if they contains spaces. For example, if you have the following recipe:
```make
search QUERY:
lynx https://www.google.com/?q={{QUERY}}
```
And you type:
```sh
$ just search "cat toupee"
```
Just will run the command `lynx https://www.google.com/?q=cat toupee`, which will get parsed by `sh` as `lynx`, `https://www.google.com/?q=cat`, and `toupee`, and not the intended `lynx` and `https://www.google.com/?q=cat toupee`.
You can fix this by adding quotes:
```make
search QUERY:
lynx 'https://www.google.com/?q={{QUERY}}'
```
=== Write Recipes in other Languages
Recipes that start with a `#!` are executed as scripts, so you can write recipes in other languages:
```make
polyglot: python js perl sh ruby
python:
#!/usr/bin/env python3
print('Hello from python!')
js:
#!/usr/bin/env node
console.log('Greetings from JavaScript!')
perl:
#!/usr/bin/env perl
print "Larry Wall says Hi!\n";
sh:
#!/usr/bin/env sh
hello='Yo'
echo "$hello from a shell script!"
ruby:
#!/usr/bin/env ruby
puts "Hello from ruby!"
```
```sh
$ just polyglot
Hello from python!
Greetings from JavaScript!
Larry Wall says Hi!
Yo from a shell script!
Hello from ruby!
```
=== Command Line Options
`just` supports a number of useful command line options for listing, dumping, and debugging recipes and variable:
```sh
$ just --list
Available recipes:
js
perl
polyglot
python
ruby
$ just --show perl
perl:
#!/usr/bin/env perl
print "Larry Wall says Hi!\n";
$ just --show polyglot
polyglot: python js perl sh ruby
```
Run `just --help` to see all the options.
=== Private Recipes
Recipes whose name starts with a `_` are omitted from `just --list`:
```make
test: _test-helper
./bin/test
_test-helper:
./bin/super-secret-test-helper-stuff
```
```sh
$ just --list
Available recipes:
test
```
And from `just --summary`:
```sh
$ just --summary
test
```
This is useful for helper recipes which are only meant to be used as dependencies of other recipes.
=== Quiet Recipes
A recipe name may be prefixed with '@' to invert the meaning of '@' before each line:
```make
@quiet:
echo hello
echo goodbye
@# all done!
```
Now only the lines starting with '@' will be echoed:
```sh
$ j quiet
hello
goodbye
# all done!
```
=== Invoking Justfiles in Other Directories
If the first argument passed to `just` contains a `/`, then the following occurs:
1. The argument is split at the last `/`.
2. The part before the last `/` is treated as a directory. Just will start its search for the justfile there, instead of in the current directory.
3. The part after the last slash is treated as a normal argument, or ignored if it is empty.
This may seem a little strange, but it's useful if you wish to run a command in a justfile that is in a subdirectory.
For example, if you are in a directory which contains a subdirectory named `foo`, which contains a justfile with the recipe `build`, which is also the default recipe, the following are all equivalent:
```sh
$ (cd foo && just build)
$ just foo/build
$ just foo/
```
== Miscellanea
=== Shell Alias
For lightning-fast command running, put `alias j=just` in your shell's configuration file.
=== Syntax Highlighting
`justfile` syntax is close enough to `make` that you may want to tell your editor to use make syntax highlighting for just.
For vim, you can put the following in `~/.vim/filetype.vim`:
```vimscript
if exists("did_load_filetypes")
finish
endif
augroup filetypedetect
au BufNewFile,BufRead Justfile,justfile setf make
augroup END
```
Include the following in a `justfile` to enable syntax highlighting in vim and emacs:
```
# Local Variables:
# mode: makefile
# End:
# vim: set ft=make :
```
Feel free to send me the commands necessary to get syntax highlighting working in your editor of choice so that I may include them here.
=== Grammar
A non-normative grammar of justfiles can be found in link:GRAMMAR.md[].
=== just.sh
Before `just` was a fancy rust program it was a tiny shell script that called `make`. You can find the old version in link:extras/just.sh[].
=== Non-Project Specific Justfile
If you want some commands to be available everwhere, put them in `~/.justfile` and add the following to your shell's initialization file:
```sh
alias .j='just --justfile ~/.justfile --working-directory ~'
```
Or, if you'd rather they run in the current directory:
```sh
alias .j='just --justfile ~/.justfile --working-directory .'
```
I'm pretty sure that nobody actually uses this feature, but it's there.
¯\\_(ツ)_/¯
== Further Ramblings
I personally find it very useful to write a `justfile` for almost every project, big or small.
On a big project with multiple contributors, it's very useful to have a file with all the commands needed to work on the project close at hand.
There are probably different commands to test, build, lint, deploy, and the like, and having them all in one place is useful and cuts down on the time you have to spend telling people which commands to run and how to type them.
And, with an easy place to put commands, it's likely that you'll come up with other useful things which are part of the project's collective wisdom, but which aren't written down anywhere, like the arcane commands needed for some part of your revision control workflow, install all your project's dependencies, or all the random flags you might need to pass to the build system.
Some ideas for recipes:
* Deploying/publishing the project
* Building in release mode vs debug mode
* Running in debug mode or with logging enabled
* Complex git workflows
* Updating dependencies
* Running different sets of tests, for example fast tests vs slow tests, or running them with verbose output
* Any complex set of commands that you really should write down somewhere, if only to be able to remember them
Even for small, personal projects it's nice to be able to remember commands by name instead of ^Reverse searching your shell history, and it's a huge boon to be able to go into an old project written in a random language with a mysterious build system and know that all the commands you need to do whatever you need to do are in the `justfile`, and that if you type `just` something useful (or at least interesting!) will probably happen.
For ideas for recipes, check out link:justfile[this project's `justfile`], or some of the `justfile`s https://github.com/search?utf8=%E2%9C%93&q=filename%3Ajustfile[out in the wild].
Anyways, I think that's about it for this incredibly long-winded README.
I hope you enjoy using `just` and find great success and satisfaction in all your computational endeavors!
😸
