Home • Explore • Blog • Models • CI
☰



nixpkgs
doc/hooks/just.section.md
bb9e2d833270c1b317367fdaebc51cfa710a066e6d2632ab000000030000046c
# `just` {#just-hook}

This setup hook attempts to use [the `just` command runner](https://just.systems/man/en/) to build, check, and install the package. The hook overrides `buildPhase`, `checkPhase`, and `installPhase` by default.

[]{#just-hook-justFlags} The `justFlags` variable can be set to a list of strings to add additional flags passed to all invocations of `just`.

## `buildPhase` {#just-hook-buildPhase}

This phase attempts to invoke `just` with [the default recipe](https://just.systems/man/en/the-default-recipe.html).

[]{#just-hook-dontUseJustBuild} This behavior can be disabled by setting `dontUseJustBuild` to `true`.

## `checkPhase` {#just-hook-checkPhase}

This phase attempts to invoke the `just test` recipe, if it is available. This can be overridden by setting `checkTarget` to a string.

[]{#just-hook-dontUseJustCheck} This behavior can be disabled by setting `dontUseJustCheck` to `true`.

## `installPhase` {#just-hook-installPhase}

This phase attempts to invoke the `just install` recipe.

[]{#just-hook-dontUseJustInstall} This behavior can be disabled by setting `dontUseJustInstall` to `true`.
Chunks
861605d6 (1st chunk of `doc/hooks/just.section.md`)
Title: The `just` Setup Hook
Summary
This document describes the `just` setup hook, which leverages the `just` command runner for package operations. By default, it overrides the `buildPhase`, `checkPhase`, and `installPhase`. Users can add global flags using `justFlags`. The `buildPhase` executes the default `just` recipe, `checkPhase` runs `just test` (or a custom `checkTarget`), and `installPhase` runs `just install`. Each of these default behaviors can be disabled by setting `dontUseJustBuild`, `dontUseJustCheck`, and `dontUseJustInstall` to `true`, respectively.