Skip to content

Shell module git root

git.root.enable

Whether to enable git root directory shell integration.

Type: boolean

Default:

false

Example:

true

Declared by: - templates/nix-shell-parts-vendored/nix/vendored/shell-modules/git-root.nix

git.root.shellVariable

The value of the git repository root directory to be used in shell scripts.

When this module is enabled, the shell hook sets the environment variable named by git.root.shellVariableName to the output of:

git rev-parse --show-toplevel

This option exposes a safe, typed way to reference that variable in other Nix configuration (for example additional shellHook fragments).

Type: string

Default:

"\${_GIT_ROOT?_GIT_ROOT is not set}"

Declared by: - templates/nix-shell-parts-vendored/nix/vendored/shell-modules/git-root.nix

git.root.shellVariableName

Name of the environment variable that will hold the git repository root inside the dev shell.

You can override the name if you need to avoid clashes with other tooling.

Type: string

Default:

"_GIT_ROOT"

Declared by: - templates/nix-shell-parts-vendored/nix/vendored/shell-modules/git-root.nix