Options reference

`cachix.package`

The cachix package to use.

Typepackage

Defaultpkgs.cachix

`cachix.pull`

Which Cachix caches to pull from.

Typelist of string

Default[ "devenv" ]

`cachix.push`

Which Cachix cache to push to. This cache is also added to cachix.pull.

Typenull or string

Defaultnull

See https://github.com/LuaLS/lua-language-server/wiki/Configuration-File#luarcjson

certFile

`certFile`

Custom certificate file name, uses mkcert default if unset

Typenull or string

Defaultnull

Example"mycert.pem"

Declared indevenv/blob/main/src/modules/integrations/mkcert.nix

certificates

`certificates`

List of domains to generate certificates for.

Typelist of string

Default[ ]

Example

[
  "example.com"
  "*.example.com"
]

Declared indevenv/blob/main/src/modules/integrations/mkcert.nix

changelogs

`changelogs`

List of changelog entries for this module.

Typelist of (submodule)

Default[ ]

Declared indevenv/blob/main/src/modules/changelogs.nix

`changelogs.*.date`

Date of the changelog entry in YYYY-MM-DD format.

Typestring matching the pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example"2025-01-15"

Declared indevenv/blob/main/src/modules/changelogs.nix

`changelogs.*.description`

Markdown description of the change.

Typestring

Declared indevenv/blob/main/src/modules/changelogs.nix

`changelogs.*.title`

Title of the changelog entry.

Typestring

Example"git-hooks.package is now pkgs.prek"

Declared indevenv/blob/main/src/modules/changelogs.nix

`changelogs.*.when`

Whether to include this changelog entry (useful for conditional changelogs).

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/changelogs.nix

claude

`claude.code.agent`

The agent to use as Claude Code's primary agent.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.agents`

Custom Claude Code sub-agents to create in the project. Sub-agents are specialized AI assistants that handle specific tasks with their own context window and can be invoked automatically or explicitly.

For more details, see: https://docs.anthropic.com/en/docs/claude-code/sub-agents

Typeattribute set of (submodule)

Default{ }

Example

{
  code-reviewer = {
    description = "Expert code review specialist that checks for quality, security, and best practices. Use proactively after code changes.";
    model = "opus";
    tools = [ "Read" "Grep" "TodoWrite" ];
    permissionMode = "plan";
    prompt = ''
      You are an expert code reviewer. When reviewing code, check for:
      - Code readability and maintainability
      - Proper error handling
      - Security vulnerabilities
      - Performance issues
      - Adherence to project conventions

      Provide constructive feedback with specific suggestions for improvement.
    '';
  };

  test-writer = {
    description = "Specialized in writing comprehensive test suites";
    tools = [ "Read" "Write" "Edit" "Bash" ];
    prompt = ''
      You are a test writing specialist. Create comprehensive test suites that:
      - Cover edge cases and error conditions
      - Follow the project's testing conventions
      - Include unit, integration, and property-based tests where appropriate
      - Have clear test names that describe what is being tested
    '';
  };
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.agents.<name>.description`

What the sub-agent does

Typestring

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.agents.<name>.effort`

Override the effort level for this agent.

Typenull or one of "low", "medium", "high", "xhigh", "max"

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.agents.<name>.model`

Override the model for this agent. Accepts an alias (sonnet, opus, haiku, fable), a full model ID (e.g. claude-opus-5), or inherit.

Typenull or string

Defaultnull

Example"opus"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.agents.<name>.permissionMode`

Permission mode for this specific sub-agent. manual is an alias for default.

Typenull or one of "default", "manual", "acceptEdits", "plan", "auto", "dontAsk", "bypassPermissions"

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.agents.<name>.prompt`

The system prompt for the sub-agent

Typestrings concatenated with "\n"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.agents.<name>.tools`

List of allowed tools for this sub-agent

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.apiKeyHelper`

Custom script for generating authentication tokens. The script should output the API key to stdout.

Typenull or string

Defaultnull

Example"aws secretsmanager get-secret-value --secret-id claude-api-key | jq -r .SecretString"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.cleanupPeriodDays`

Retention period for chat transcripts in days.

Typenull or signed integer

Defaultnull

Example30

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.commands`

Custom Claude Code slash commands to create in the project. Commands are invoked with /command-name in Claude Code.

Typeattribute set of string

Default{ }

Example

{
  test = ''
    Run all tests in the project

    ```bash
    cargo test
    ```
  '';
  fmt = ''
    Format all code in the project

    ```bash
    cargo fmt
    nixfmt **/*.nix
    ```
  '';
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.enable`

Whether to enable Claude Code integration with automatic hooks and commands setup.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.env`

Custom environment variables for Claude Code sessions.

Typeattribute set of string

Default{ }

Example

{
  NODE_ENV = "development";
  PYTHONPATH = "/custom/python/path";
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.forceLoginMethod`

Restrict the login method.

claudeai: only claude.ai accounts
console: only Claude Console (API key) accounts
gateway: only a cloud gateway

Typenull or one of "claudeai", "console", "gateway"

Defaultnull

Example"claudeai"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.hooks`

Hooks that run at different points in Claude Code's workflow.

Typeopen submodule of attribute set of (submodule)

Default{ }

Example

{
  protect-secrets = {
    enable = true;
    name = "Protect sensitive files";
    hookType = "PreToolUse";
    matcher = "^(Edit|MultiEdit|Write)$";
    command = ''
      json=$(cat);
      file_path = $(echo "$json" | jq - r '.file_path // empty');
      grep -q 'SECRET\\|PASSWORD\\|API_KEY' "$file_path" && echo 'Blocked: sensitive data detected' && exit 1 || exit 0
    '';
  };
  run-tests = {
    enable = true;
    name = "Run tests after edit";
    hookType = "PostToolUse";
    matcher = "^(Edit|MultiEdit|Write)$";
    command = "cargo test";
  };
  log-completion = {
    enable = true;
    name = "Log when Claude finishes";
    hookType = "Stop";
    command = "echo 'Claude finished responding' >> claude.log";
  };
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.hooks.<name>.command`

The command to execute.

Typestring

`claude.code.hooks.<name>.enable`

Whether to enable this hook.

Typeboolean

Defaulttrue

`claude.code.hooks.<name>.hookType`

The type of hook:

PreToolUse: Runs before tool calls (can block them)
PostToolUse: Runs after tool calls complete
PostToolUseFailure: Runs after a tool call fails
Notification: Runs when Claude Code sends notifications
UserPromptSubmit: Runs when user submits a prompt
SessionStart: Runs when a Claude Code session starts
SessionEnd: Runs when a Claude Code session ends
Stop: Runs when Claude Code finishes responding
SubagentStart: Runs when a subagent task starts
SubagentStop: Runs when subagent tasks complete
PreCompact: Runs before message compaction
PermissionRequest: Runs when a permission is requested
WorktreeCreate: Runs when a new worktree is created
WorktreeRemove: Runs when a worktree is removed
TeammateIdle: Runs when a teammate agent becomes idle
TaskCompleted: Runs when a task is completed
ConfigChange: Runs when configuration changes

Typeone of "PreToolUse", "PostToolUse", "PostToolUseFailure", "Notification", "UserPromptSubmit", "SessionStart", "SessionEnd", "Stop", "SubagentStart", "SubagentStop", "PreCompact", "PermissionRequest", "WorktreeCreate", "WorktreeRemove", "TeammateIdle", "TaskCompleted", "ConfigChange"

Default"PostToolUse"

`claude.code.hooks.<name>.matcher`

Regex pattern to match against tool names (for PreToolUse/PostToolUse hooks).

Typestring

Default""

`claude.code.hooks.<name>.name`

The name of the hook (appears in logs).

Typestring

Default""

`claude.code.hooks.git-hooks-run`

Automatically runs git-hooks after Claude edits files. Enabled by default when git-hooks.enable is true.

Typesubmodule

Default

{
  enable = config.git-hooks.enable;
  name = "Run git-hooks";
  hookType = "PostToolUse";
  matcher = "^(Edit|MultiEdit|Write)$";
  command = "cd \"$DEVENV_ROOT\" && \${config.git-hooks.package.meta.mainProgram} run";
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.hooks.git-hooks-run.command`

The command to execute.

Typestring

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.hooks.git-hooks-run.enable`

Whether to enable this hook.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.hooks.git-hooks-run.hookType`

The type of hook:

PreToolUse: Runs before tool calls (can block them)
PostToolUse: Runs after tool calls complete
PostToolUseFailure: Runs after a tool call fails
Notification: Runs when Claude Code sends notifications
UserPromptSubmit: Runs when user submits a prompt
SessionStart: Runs when a Claude Code session starts
SessionEnd: Runs when a Claude Code session ends
Stop: Runs when Claude Code finishes responding
SubagentStart: Runs when a subagent task starts
SubagentStop: Runs when subagent tasks complete
PreCompact: Runs before message compaction
PermissionRequest: Runs when a permission is requested
WorktreeCreate: Runs when a new worktree is created
WorktreeRemove: Runs when a worktree is removed
TeammateIdle: Runs when a teammate agent becomes idle
TaskCompleted: Runs when a task is completed
ConfigChange: Runs when configuration changes

Default"PostToolUse"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.hooks.git-hooks-run.matcher`

Regex pattern to match against tool names (for PreToolUse/PostToolUse hooks).

Typestring

Default""

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.hooks.git-hooks-run.name`

The name of the hook (appears in logs).

Typestring

Default""

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.mcpServers`

MCP (Model Context Protocol) servers to configure. These servers provide additional capabilities and context to Claude Code.

Typeattribute set of (submodule)

Default

{
  "mcp.devenv.sh" = {
    type = "http";
    url = "https://mcp.devenv.sh";
  };
}

Example

{
  awslabs-iam-mcp-server = {
    type = "stdio";
    command = lib.getExe pkgs.awslabs-iam-mcp-server;
    args = [ ];
    env = { };
  };
  github = {
    type = "http";
    url = "https://api.githubcopilot.com/mcp/";
    headers = {
      Authorization = "Bearer GITHUB_PAT";
    };
  };
  linear = {
    type = "http";
    url = "https://mcp.linear.app/mcp";
  };
  devenv = {
    type = "stdio";
    command = "devenv";
    args = [ "mcp" ];
    env = {
      DEVENV_ROOT = config.devenv.root;
    };
  };
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.mcpServers.<name>.args`

Arguments to pass to the command for stdio MCP servers.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.mcpServers.<name>.command`

Command to execute for stdio MCP servers.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.mcpServers.<name>.env`

Environment variables for stdio MCP servers.

Typeattribute set of string

Default{ }

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.mcpServers.<name>.headers`

HTTP headers for HTTP MCP servers (e.g., for authentication).

Typeattribute set of string

Default{ }

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.mcpServers.<name>.type`

Type of MCP server connection.

Typeone of "stdio", "http"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.mcpServers.<name>.url`

URL for HTTP MCP servers.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.model`

Override the default Claude model.

Typenull or string

Defaultnull

Example"claude-3-opus-20240229"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.permissions`

Fine-grained permissions for tool usage. Supports global settings and per-tool allow/ask/deny rules. Tool rules can be placed under rules or directly (backward compatible).

Typeopen submodule of attribute set of (submodule)

Default{ }

Example

{
  defaultMode = "acceptEdits";
  disableBypassPermissionsMode = true;
  additionalDirectories = [ "/shared/libs" ];
  rules = {
    Edit = {
      deny = [ "*.secret" "*.env" ];
    };
    Bash = {
      allow = [ "ls:*" "cat:*" ];
      ask = [ "git:*" "npm:*" ];
      deny = [ "rm -rf:*" "sudo:*" ];
    };
    # Use an empty string to emit a bare tool entry for tools
    # without a matcher format (e.g. WebSearch, AskUserQuestion).
    WebSearch.allow = [ "" ];
    AskUserQuestion.deny = [ "" ];
  };
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.permissions.<name>.allow`

List of allowed patterns. An empty string emits a bare tool entry (e.g. WebSearch rather than WebSearch(pattern)), matching the tool regardless of input. Use this for tools without a matcher format such as WebSearch or AskUserQuestion.

Typelist of string

Default[ ]

`claude.code.permissions.<name>.ask`

List of patterns that require user approval. An empty string emits a bare tool entry (e.g. WebSearch rather than WebSearch(pattern)).

Typelist of string

Default[ ]

`claude.code.permissions.<name>.deny`

List of denied patterns. An empty string emits a bare tool entry (e.g. AskUserQuestion rather than AskUserQuestion(pattern)), which is required to deny tools without a matcher format outright.

Typelist of string

Default[ ]

`claude.code.permissions.additionalDirectories`

Allow Claude Code to access directories outside the project root.

Typelist of string

Default[ ]

Example

[
  "/shared/libs"
  "/common/configs"
]

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.permissions.defaultMode`

Global permission mode for Claude Code.

default: Prompts on first use of each tool (manual is an alias)
acceptEdits: Auto-accepts file edits
plan: Read-only mode
auto: Auto-approves tool calls with background safety checks
dontAsk: Auto-denies unless pre-approved via permissions
bypassPermissions: Skips all permission prompts

Typenull or one of "default", "manual", "acceptEdits", "plan", "auto", "dontAsk", "bypassPermissions"

Defaultnull

Example"acceptEdits"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.permissions.disableBypassPermissionsMode`

Security option to prevent the dangerous bypassPermissions mode. Written to settings.json as "disableBypassPermissionsMode": "disable".

Typenull or boolean

Defaultnull

Exampletrue

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.permissions.rules`

Per-tool permission rules. Preferred location for tool permissions.

Typeattribute set of (submodule)

Default{ }

Declared indevenv/blob/main/src/modules/integrations/claude.nix

Custom Claude Code skills to create in the project. A skill is a folder of instructions Claude loads on demand when its description matches the task, keeping specialised knowledge out of the always-on context.

For more details, see: https://docs.anthropic.com/en/docs/claude-code/skills

Typeattribute set of (submodule)

Default{ }

Example

{
  database-migrations = {
    description = "How to write and run migrations in this project. Use when adding, editing or rolling back a migration.";
    content = ''
      Migrations live in `migrations/` and are applied with `diesel migration run`.

      - One logical change per migration; never edit an applied migration.
      - Always write the matching `down.sql`.
      - Run `devenv tasks run db:reset` before opening a pull request.
    '';
  };

  api-conventions = {
    description = "REST conventions for this codebase. Use when adding or changing an HTTP endpoint.";
    allowedTools = [ "Read" "Grep" ];
    resources = {
      "references/error-codes.md" = ./docs/error-codes.md;
    };
    content = ''
      Endpoints are versioned under `/v1`.
      Read references/error-codes.md before inventing a new error code.
    '';
  };
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.agent`

Which subagent type to use when context = "fork" is set, such as one of claude.code.agents.

Typenull or string

Defaultnull

Example"code-reviewer"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.allowedTools`

Tools Claude can use without asking permission during the turn that invokes this skill. The grant clears when you send your next message.

This pre-approves tools rather than restricting them; use disallowedTools to take tools away.

Typelist of string

Default[ ]

Example

[
  "Read"
  "Grep"
  "Bash(git status:*)"
]

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.argumentHint`

Hint shown during autocomplete to indicate the expected arguments.

Typenull or string

Defaultnull

Example"[issue-number]"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.arguments`

Named positional arguments, substituted into content as $name. Names map to argument positions in order.

Typelist of string

Default[ ]

Example

[
  "issue"
  "branch"
]

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.background`

Only applies with context = "fork". Set to false to wait for the forked subagent's result in the turn that invoked the skill, instead of letting it run in the background.

Typenull or boolean

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.content`

The body of SKILL.md, loaded when the skill triggers.

Typestrings concatenated with "\n"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.context`

Set to fork to run the skill in a forked subagent context.

Typenull or value "fork" (singular enum)

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.copyMode`

How to materialise the skill's files, as in files.<name>.copyMode. Use seed to hand-edit a skill after devenv writes it once.

Typeone of "symlink", "seed", "copy"

Default"symlink"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.description`

What the skill covers and when Claude should load it. Descriptions are the only part of a skill kept in context at all times, so this is what decides whether the skill ever triggers.

Typestring

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.disableModelInvocation`

Prevent Claude from automatically loading this skill. Use for workflows you want to trigger manually with /‹name›.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.disallowedTools`

Tools removed from Claude's available pool while this skill is active; the restriction clears when you send your next message. Use it for a skill that should never call a given tool, such as an autonomous loop that must not stop to ask a question.

Typelist of string

Default[ ]

Example

[
  "AskUserQuestion"
]

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.effort`

Override the effort level while this skill is active. Which levels are available depends on the model.

Typenull or one of "low", "medium", "high", "xhigh", "max"

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.model`

Model to use while this skill is active, for the rest of the current turn. Accepts an alias (sonnet, opus, haiku, fable), a full model ID (e.g. claude-opus-5), or inherit. With context = "fork" it sets the forked subagent's model instead.

Typenull or string

Defaultnull

Example"opus"

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.resources`

Files placed alongside SKILL.md, keyed by path relative to the skill directory. Claude reads these on demand, so bulky reference material belongs here rather than in content.

Typeattribute set of ((submodule) or absolute path convertible to it)

Default{ }

Example

{
  "references/api.md" = ./api.md;
  "scripts/check.sh" = { source = ./check.sh; executable = true; };
}

Declared indevenv/blob/main/src/modules/integrations/claude.nix

`claude.code.skills.<name>.whenToUse`

Additional context for when Claude should invoke the skill, such as trigger phrases or example requests. Appended to description in the skill listing and counts toward the 1536-character cap.

Typenull or string

Defaultnull

Example"Use when the user mentions migrations, schema changes or rollbacks."

Declared indevenv/blob/main/src/modules/integrations/claude.nix

container

`container.isBuilding`

Devenv set it to true when the environment is a container.

Example:

{ pkgs, config, lib, ... }:
{
  packages = [ pkgs.openssl ]
  ++ lib.optionals (!config.container.isBuilding) [ pkgs.git ];
}

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/containers.nix

containers

`containers`

Container specifications that can be built, copied and ran using devenv container.

Typeattribute set of (submodule)

Default{ }

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.copyToRoot`

Add a path to the container. Defaults to the whole git repo.

Typeabsolute path or list of absolute path

Defaultself

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.defaultCopyArgs`

Default arguments to pass to skopeo copy. You can override them by passing arguments to the script.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.enableLayerDeduplication`

Whether to enable layer deduplication using the approach described at https://blog.eigenvalue.net/2023-nix2container-everything-once/ .

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.entrypoint`

Entrypoint of the container.

Typelist of anything

Default[ entrypoint ]

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.fromImage`

An existing OCI base image to build on top of, built with nix2container's pullImage.

Typenull or package

Defaultnull

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.isBuilding`

Set to true when the environment is building this container.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers`

The layers to create.

Typelist of (submodule)

Default[ ]

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers.*.copyToRoot`

A list of derivations copied to the image root directory.

Store path prefixes /nix/store/hash-path are removed in order to relocate them to the image /.

Typelist of package

Default[ ]

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers.*.deps`

A list of store paths to include in the layer.

Typelist of package

Default[ ]

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers.*.ignore`

A store path to ignore when building the layer. This is mainly useful to ignore the configuration file from the container layer.

Typenull or path in the Nix store

Defaultnull

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers.*.maxLayers`

The maximum number of layers to create.

Typesigned integer

Default1

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers.*.perms`

A list of file permissions which are set when the tar layer is created.

These permissions are not written to the Nix store.

Typelist of (submodule)

Default[ ]

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers..perms..gid`

The group ID to apply to all of the files matched by the regex.

Typenull or signed integer

Defaultnull

Example"1000"

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers..perms..gname`

The group name to apply to all of the files matched by the regex.

Typenull or string

Defaultnull

Example"root"

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers..perms..mode`

The numeric permissions mode to apply to all of the files matched by the regex.

Typenull or string

Defaultnull

Example"644"

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers..perms..path`

A store path.

Typepath in the Nix store

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers..perms..regex`

A regex pattern to select files or directories to apply the mode to.

Typenull or string

Defaultnull

Example".*"

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers..perms..uid`

The user ID to apply to all of the files matched by the regex.

Typenull or signed integer

Defaultnull

Example"1000"

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.layers..perms..uname`

The user name to apply to all of the files matched by the regex.

`containers.<name>.version`

Version/tag of the container.

Typenull or string

Default"latest"

Declared indevenv/blob/main/src/modules/containers.nix

`containers.<name>.workingDir`

Working directory of the container.

Typestring

Default"/env"

Declared indevenv/blob/main/src/modules/containers.nix

delta

`delta.enable`

Integrate delta into git: https://dandavison.github.io/delta/.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/integrations/delta.nix

devcontainer

`devcontainer.enable`

Whether to enable generation .devcontainer.json for devenv integration.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/integrations/devcontainer.nix

`devcontainer.settings`

Devcontainer settings.

Typeopen submodule of (JSON value)

Default{ }

Declared indevenv/blob/main/src/modules/integrations/devcontainer.nix

`devcontainer.settings.customizations.vscode.extensions`

A list of pre-installed VS Code extensions.

Typelist of string

Default

[
  "mkhl.direnv"
]

Declared indevenv/blob/main/src/modules/integrations/devcontainer.nix

`devcontainer.settings.customizations.zed.extensions`

A list of pre-installed Zed extensions.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/integrations/devcontainer.nix

`devcontainer.settings.image`

The name of an image in a container registry.

Typestring

Default"ghcr.io/cachix/devenv/devcontainer:latest"

Declared indevenv/blob/main/src/modules/integrations/devcontainer.nix

`devcontainer.settings.overrideCommand`

Override the default command.

Typeanything

Defaultfalse

Declared indevenv/blob/main/src/modules/integrations/devcontainer.nix

`devcontainer.settings.updateContentCommand`

A command to run after the container is created.

Typeanything

Default"devenv test"

Declared indevenv/blob/main/src/modules/integrations/devcontainer.nix

devenv

`devenv.cliVersion`

Alias of {option}devenv.cli.version.

Typenull or string

Declared indevenv/blob/main/src/modules/update-check.nix

`devenv.debug`

Whether to enable debug mode of devenv enterShell script.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/debug.nix

`devenv.flakesIntegration`

Tells if devenv is being imported by a flake.nix file

Typeboolean

Default`true` when devenv is invoked via the flake integration; `false` otherwise.

Declared indevenv/blob/main/src/modules/update-check.nix

`devenv.isTesting`

Whether the environment is being used for testing.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/tests.nix

`devenv.latestVersion`

The latest version of devenv.

Typestring

Default"2.2.2"

Declared indevenv/blob/main/src/modules/update-check.nix

The path of the dotenv file to load, or a list of dotenv files to load in order of precedence.

Typestring or list of string

Default".env"

Declared indevenv/blob/main/src/modules/integrations/dotenv.nix

`dotenv.substitution`

Whether to expand variable references such as $NAME, ${NAME}, and ${NAME:-default} in dotenv values. Disabled by default so dollar signs in passwords, hashes, and tokens remain literal.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/integrations/dotenv.nix

enterShell

`enterShell`

Bash code to execute when entering the shell.

Typestrings concatenated with "\n"

Default""

Declared indevenv/blob/main/src/modules/top-level.nix

enterTest

`enterTest`

Bash code to execute to run the test.

Typestrings concatenated with "\n"

Declared indevenv/blob/main/src/modules/tests.nix

env

`env`

Environment variables to be exposed inside the developer environment.

Typeopen submodule of lazy attribute set of anything

Default{ }

Declared indevenv/blob/main/src/modules/top-level.nix

files

`files`

A set of files that will be linked into devenv root.

Typeattribute set of (submodule)

Default{ }

Declared indevenv/blob/main/src/modules/files.nix

`files.<name>.copyMode`

How to materialize the file in the project root:

symlink (default): symlink to the read-only file in the Nix store. Edits are not possible; devenv keeps the link pointed at the current contents.
seed: copy the file into place once, only if it does not already exist, and make it writable. Existing files are left untouched, so your edits are preserved. Useful for seeding configuration from templates the user then edits.
copy: copy the file into place as a writable file, overwriting it with fresh contents on every shell entry. Useful when a tool must write to the file in place but devenv should remain the source of truth.

Git repository root path. This field is populated automatically in devenv 1.10 and newer.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/git.nix

git-hooks

`git-hooks`

Integration with https://github.com/cachix/git-hooks.nix

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/integrations/git-hooks.nix

`git-hooks.addGcRoot`

Whether to add the generated pre-commit config to the garbage collector roots. This prevents Nix from garbage-collecting the tools used by hooks.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.configFile`

The pre-commit configuration file.

Typepackage

Default"<derivation>"

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.configPath`

The path where to generate the pre-commit configuration file.

This path is relative to the root of the project. By default, this is set to ".pre-commit-config.yaml", which is the standard location expected by pre-commit.

Typestring

Default".pre-commit-config.yaml"

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.default_stages`

A configuration wide option for the stages property. Installs hooks to the defined stages. See https://pre-commit.com/#confining-hooks-to-run-at-certain-stages.

Typelist of (one of "commit-msg", "post-checkout", "post-commit", "post-merge", "post-rewrite", "pre-commit", "pre-merge-commit", "pre-push", "pre-rebase", "prepare-commit-msg", "manual", "commit", "push", "merge-commit")

Default

[
  "pre-commit"
]

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.enable`

Whether to enable the pre-commit hooks module.

When set to false, this disables the entire module.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.enabledPackages`

All packages provided by hooks that are enabled.

Useful for including into the developer environment.

Typelist of unspecified value

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.excludes`

Exclude files that were matched by these patterns.

Typelist of string

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.gitPackage`

The git package to use.

Typepackage

Defaultpkgs.gitMinimal

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.hooks`

The hook definitions.

You can both specify your own hooks here and you can enable predefined hooks.

Example of enabling a predefined hook:

hooks.nixpkgs-fmt.enable = true;

Example of a custom hook:

hooks.my-tool = {
  enable = true;
  name = "my-tool";
  description = "Run MyTool on all files in the project";
  files = "\\.mtl$";
  entry = "${pkgs.my-tool}/bin/mytoolctl";
};

The predefined hooks are:

action-validator

Tool to validate GitHub Action and Workflow YAML files

actionlint

Static checker for GitHub Actions workflow files

alejandra

The Uncompromising Nix Code Formatter

annex

Runs the git-annex hook for large file support

ansible-lint

Ansible linter

autoflake

Remove unused imports and variables from Python code

bats

Run bash unit tests

beautysh

Format shell files

biome

A toolchain for web projects, aimed to provide functionalities to maintain them

black

The uncompromising Python code formatter

cabal-fmt

Format Cabal files

cabal-gild

Format Cabal files

cabal2nix

Run cabal2nix on all *.cabal files to generate corresponding .nix files

cargo-check

Check the cargo package for errors

chart-testing

CLI tool for linting and testing Helm charts

check-added-large-files

Prevent very large files to be committed (e.g. binaries).

check-builtin-literals

Require literal syntax when initializing empty or zero builtin types in Python.

check-case-conflicts

Check for files that would conflict in case-insensitive filesystems.

check-docstring-first

Check that all docstrings appear above the code.

check-executables-have-shebangs

Ensure that all non-binary executables have shebangs.

check-json

Check syntax of JSON files.

check-merge-conflicts

Check for files that contain merge conflict strings.

check-python

Check syntax of Python file by parsing Python abstract syntax tree.

check-shebang-scripts-are-executable

Ensure that all (non-binary) files with a shebang are executable.

check-symlinks

Find broken symlinks.

check-toml

Check syntax of TOML files.

check-vcs-permalinks

Ensure that links to VCS websites are permalinks.

check-xml

Check syntax of XML files.

check-yaml

Check syntax of YAML files.

checkmake

Experimental linter/analyzer for Makefiles

chktex

LaTeX semantic checker

circleci

Validate CircleCI config files.

clang-format

Format your code using clang-format.

clang-tidy

Static analyzer for C++ code.

clippy

Lint Rust code.

cljfmt

A tool for formatting Clojure code.

cmake-format

A tool for formatting CMake-files.

commitizen

Check whether the current commit message follows committing rules.

comrak

A 100% CommonMark-compatible GitHub Flavored Markdown formatter

conform

Policy enforcement for commits.

convco

credo

Runs a static code analysis using Credo

crystal

A tool that automatically formats Crystal source code

cspell

A Spell Checker for Code

cue-fmt

Format CUE files

dart-analyze

Dart analyzer

dart-format

Dart formatter

deadnix

Scan Nix files for dead code (unused variable bindings).

denofmt

Auto-format JavaScript, TypeScript, Markdown, and JSON files.

denolint

Lint JavaScript/TypeScript source code.

detect-aws-credentials

Detect AWS credentials from the AWS cli credentials file.

detect-private-keys

Detect the presence of private keys.

dhall-format

Dhall code formatter.

dialyzer

Runs a static code analysis using Dialyzer

dune-fmt

Runs Dune's formatters on the code tree.

dune-opam-sync

Check that Dune-generated OPAM files are in sync.

eclint

EditorConfig linter written in Go.

editorconfig-checker

Verify that the files are in harmony with the .editorconfig.

elm-format

Format Elm files.

elm-review

Analyzes Elm projects, to help find mistakes before your users find them.

elm-test

Run unit tests and fuzz tests for Elm code.

end-of-file-fixer

Ensures that a file is either empty, or ends with a single newline.

eslint

Find and fix problems in your JavaScript code.

fix-byte-order-marker

Remove UTF-8 byte order marker.

fix-encoding-pragma

Adds # -- coding: utf-8 -- to the top of Python files.'

flake-checker

Run health checks on your flake-powered Nix projects.

flake8

Check the style and quality of Python files.

flynt

CLI tool to convert a python project's %-formatted strings to f-strings.

forbid-new-submodules

Prevent addition of new Git submodules.

fourmolu

Haskell code prettifier.

fprettify

Auto-formatter for modern Fortran code.

gitlint

Linting for your git commit messages

gofmt

A tool that automatically formats Go source code

golangci-lint

Fast linters runner for Go.

golines

A golang formatter that fixes long lines

gotest

Run go tests

govet

Checks correctness of Go programs.

gptcommit

Generate a commit message using GPT3.

hadolint

Dockerfile linter, validate inline bash.

headache

Lightweight tool for managing headers in source code files.

hindent

Haskell code prettifier.

hledger-fmt

Opinionated hledger's journal files formatter.

hlint

HLint gives suggestions on how to improve your source code.

hpack

hpack converts package definitions in the hpack format (package.yaml) to Cabal files.

html-tidy

HTML linter.

hunspell

Spell checker and morphological analyzer.

isort

A Python utility / library to sort imports.

juliaformatter

Run JuliaFormatter.jl against Julia source files

keep-sorted

Language-agnostic formatter that sorts lines between two markers in a larger file.

lacheck

A consistency checker for LaTeX documents.

latexindent

Perl script to add indentation to LaTeX files.

lua-ls

Uses the lua-language-server CLI to statically type-check and lint Lua code.

luacheck

A tool for linting and static analysis of Lua code.

lychee

A fast, async, stream-based link checker that finds broken hyperlinks and mail addresses inside Markdown, HTML, reStructuredText, or any other text file or website.

markdownlint

Style checker and linter for markdown files.

mdformat

CommonMark compliant Markdown formatter

mdl

A tool to check markdown files and flag style issues.

mdsh

Markdown shell pre-processor.

mix-format

Runs the built-in Elixir syntax formatter

mix-test

Runs the built-in Elixir test framework

mixed-line-endings

Resolve mixed line endings.

mkdocs-linkcheck

Validate links associated with markdown-based, statically generated websites.

mypy

Static type checker for Python

name-tests-test

Verify that Python test files are named correctly.

nbstripout

Strip output from Jupyter notebooks

nil

Incremental analysis assistant for writing in Nix.

nixf-diagnose

wrapper for nixf-tidy.

nixfmt

Official Nix code formatter.

nixfmt-classic

Nix code prettifier (classic).

nixfmt-rfc-style

Nix code prettifier (RFC 166 style).

nixpkgs-fmt

Nix code prettifier.

no-commit-to-branch

Disallow committing to certain branch/branches.

ocp-indent

A tool to indent OCaml code.

opam-lint

OCaml package manager configuration checker.

openapi-spec-validator

A tool to validate OpenAPI spec files

ormolu

Haskell code prettifier.

php-cs-fixer

Lint PHP files.

phpcbf

Lint PHP files.

phpcs

Lint PHP files.

phpstan

Static Analysis of PHP files.

poetry-check

Check the Poetry config for errors

poetry-lock

Update the Poetry lock file

pre-commit-hook-ensure-sops

prettier

Opinionated multi-language code formatter.

pretty-format-json

Formats JSON files.

proselint

A linter for prose.

psalm

Static Analysis of PHP files.

purs-tidy

Format purescript files.

pylint

Lint Python files.

pyright

Static type checker for Python

python-debug-statements

Check for debugger imports and py37+ breakpoint() calls in python source.

pyupgrade

Automatically upgrade syntax for newer versions.

regal

A linter for Rego policies

reuse

reuse is a tool for compliance with the REUSE recommendations.

revive

A linter for Go source code.

ripsecrets

Prevent committing secret keys into your source code

rome

ruff

An extremely fast Python linter, written in Rust.

ruff-format

An extremely fast Python code formatter, written in Rust.

rumdl

Style checker and linter for rumdl files.

rustfmt

Format Rust code.

selene

A blazing-fast modern Lua linter written in Rust.

shellcheck

Format shell files.

shfmt

Format shell files.

single-quoted-strings

Replace double quoted strings with single quoted strings.

sort-file-contents

Sort the lines in specified files (defaults to alphabetical).

sort-requirements-txt

Sort requirements in requirements.txt and constraints.txt files.

sort-simple-yaml

Sort simple YAML files which consist only of top-level keys, preserving comments and blocks.

staticcheck

State of the art linter for the Go programming language

statix

Lints and suggestions for the Nix programming language.

stylish-haskell

A simple Haskell code prettifier

stylua

An Opinionated Lua Code Formatter.

tagref

Have tagref check all references and tags.

taplo

Format TOML files with taplo fmt

terraform-format

Format Terraform (.tf) files.

terraform-validate

Validates terraform configuration files (.tf).

tflint

A Pluggable Terraform Linter.

topiary

A universal formatter engine within the Tree-sitter ecosystem, with support for many languages.

treefmt

One CLI to format the code tree.

trim-trailing-whitespace

Trim trailing whitespace.

trufflehog

Secrets scanner

typos

Source code spell checker

typstyle

Beautiful and reliable typst code formatter

uv-check

Check if uv's lockfile is up-to-date.

uv-export

Export uv's lockfile.

uv-lock

Update uv's lockfile.

vale

A markup-aware linter for prose built with speed and extensibility in mind.

woodpecker-cli-lint

Command line client for the Woodpecker Continuous Integration server (lint only).

yamlfmt

Formatter for YAML files.

yamllint

Linter for YAML files.

zizmor

Static analysis for GitHub Actions

zprint

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.entry`

The entry point - the executable to run. {option}entry can also contain arguments that will not be overridden, such as entry = "autopep8 -i";.

Typestring

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.exclude_types`

List of file types to exclude. See Filtering files with types.

Typelist of string

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.excludes`

Exclude files that were matched by these patterns.

Typelist of string

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.extraPackages`

Additional packages required to run the hook.

These are propagated to enabledPackages for constructing developer environments.

Typelist of package

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.fail_fast`

if true pre-commit will stop running hooks if this hook fails.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.files`

The pattern of files to run on.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.id`

The unique identifier for the hook.

You do not need to set or modify this value.

The id is used to reference a hook when using pre-commit run <id>. It can also be used to reference the hook in other hooks' before and after fields to define the order in which hooks run.

The id is set to the attribute name the hook submodule is bound to in the parent module. For example, the id of following hook would be my-hook.

{
  hooks = {
    my-hook = {
      enable = true;
      entry = "my-hook";
    };
  }
}

Typestring

Default"the attribute name the hook submodule is bound to"

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.language`

The language of the hook - tells pre-commit how to install the hook.

Defaults to "system", or "unsupported" when using pre-commit >= 4.4.0.

Note: "unsupported" does not mean deprecated. Pre-commit >= 4.4.0 renamed "system" to "unsupported" because when using this language pre-commit does not provision the tools, and using externally managed tools (e.g. via Nix) is not an officially supported workflow. Both values are functionally equivalent.

Typestring

Default"system" or "unsupported" depending on pre-commit version

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.name`

The name of the hook. Shown during hook execution.

Typestring

Defaultthe attribute name the hook submodule is bound to, same as `id`

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.package`

An optional package that provides the hook.

Typenull or package

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.pass_filenames`

Whether to pass filenames as arguments to the entry point.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.priority`

Defines the order in which the hooks are executed. Default priority is set by the order in the list of hooks. Evaluation goes from 0 and up. If two hooks have the same priority, they’ll run in parallel. This works only if cfg.package is set to prek.

Typenull or 32 bit unsigned integer; between 0 and 4294967295 (both inclusive)

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.raw`

Raw fields of a pre-commit hook. This is mostly for internal use but exposed in case you need to work around something.

Default: taken from the other hook options.

Typeattribute set of unspecified value

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.require_serial`

if true this hook will execute using a single process instead of in parallel.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.stages`

Confines the hook to run at a particular stage.

Defaultdefault_stages

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.types`

List of file types to run on. See Filtering files with types.

Typelist of string

Default

[
  "file"
]

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.types_or`

List of file types to run on, where only a single type needs to match.

Typelist of string

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.<name>.verbose`

forces the output of the hook to be printed even when the hook passes.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.alejandra`

alejandra hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.alejandra.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.alejandra.settings.check`

Check if the input is already formatted and disable writing in-place the modified content

Typeboolean

Defaultfalse

Exampletrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.alejandra.settings.configPath`

(experimental) Path to the alejandra.toml configuration file.

Typenull or string or absolute path

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.alejandra.settings.exclude`

Files or directories to exclude from formatting.

Typelist of string

Default[ ]

Example

[
  "flake.nix"
  "./templates"
]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.alejandra.settings.threads`

Number of formatting threads to spawn.

Typenull or signed integer

Defaultnull

Example8

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.alejandra.settings.verbosity`

Whether informational messages or all messages should be hidden or not.

Typeone of "normal", "quiet", "silent"

Default"normal"

Example"quiet"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.ansible-lint`

ansible-lint hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.ansible-lint.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.ansible-lint.settings.configPath`

Path to the YAML configuration file.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.ansible-lint.settings.subdir`

Path to the Ansible subdirectory.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.autoflake`

autoflake hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.autoflake.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.autoflake.settings.binPath`

Path to autoflake binary.

Typenull or string

Default

"${tools.autoflake}/bin/autoflake"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.autoflake.settings.flags`

Flags passed to autoflake.

Typestring

Default"--in-place --expand-star-imports --remove-duplicate-keys --remove-unused-variables"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.biome`

biome hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.biome.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.biome.settings.binPath`

biome binary path. For example, if you want to use the biome binary from node_modules, use "./node_modules/.bin/biome". Use a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.

Typenull or string or absolute path

Default

"${tools.biome}/bin/biome"

Example

"./node_modules/.bin/biome"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.biome.settings.configPath`

Path to the configuration JSON file

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.biome.settings.write`

Whether to edit files inplace.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.black`

black hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.black.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.black.settings.flags`

Flags passed to black. See all available here.

Typestring

Default""

Example"--skip-magic-trailing-comma"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.cabal2nix`

cabal2nix hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.cabal2nix.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.cabal2nix.settings.outputFilename`

The name of the output file generated after running cabal2nix.

Typestring

Default"default.nix"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.clippy.settings.extraArgs`

Additional arguments to pass to clippy

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.clippy.settings.offline`

Run clippy offline

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.cmake-format`

cmake-format hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.cmake-format.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.cmake-format.settings.configPath`

Don't print a dead code report.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.denofmt`

denofmt hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.denofmt.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.denofmt.settings.configPath`

Path to the configuration JSON file

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.denofmt.settings.write`

Whether to edit files inplace.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.denolint`

denolint hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.denolint.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.denolint.settings.configPath`

Path to the configuration JSON file

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.denolint.settings.format`

Output format.

Typeone of "default", "compact", "json"

Default"default"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.dune-fmt`

dune-fmt hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.dune-fmt.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.dune-fmt.settings.auto-promote`

Whether to auto-promote the changes.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.dune-fmt.settings.extraRuntimeInputs`

Extra runtimeInputs to add to the environment, eg. ocamlformat.

Typelist of package

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

Log level verbosity

Typeone of 0, 1, 2, 3, 4

Default0

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.eslint`

eslint hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.eslint.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.eslint.settings.binPath`

eslint binary path. For example, if you want to use the eslint binary from node_modules, use "./node_modules/.bin/eslint". Use a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.

Typenull or string or absolute path

Default

"${tools.eslint}/bin/eslint"

Example

"./node_modules/.bin/eslint"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.eslint.settings.extensions`

The pattern of files to run on, see https://pre-commit.com/#hooks-files.

Typestring

Default"\\.js$"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.flake8`

flake8 hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.flake8.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.flake8.settings.binPath`

flake8 binary path. Should be used to specify flake8 binary from your Python environment.

Typenull or string

Default

"${tools.flake8}/bin/flake8"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.flake8.settings.extendIgnore`

List of additional ignore codes

Typelist of string

Default[ ]

Example

[
  "E501"
]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.flake8.settings.format`

Output format.

Typestring

Default"default"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

Run with verbose output.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.fourmolu`

fourmolu hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.fourmolu.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.fourmolu.settings.defaultExtensions`

Haskell language extensions to enable.

Typelist of string

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.golines`

golines hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.golines.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.golines.settings.flags`

Flags passed to golines. See all available here

Typestring

Default""

Example"-m 120"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.gotest`

gotest hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.gotest.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.gotest.settings.flags`

`git-hooks.hooks.isort.settings.flags`

Flags passed to isort. See all available here.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.isort.settings.profile`

Built-in profiles to allow easy interoperability with common projects and code styles.

Typeone of "", "black", "django", "pycharm", "google", "open_stack", "plone", "attrs", "hug", "wemake", "appnexus"

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.lacheck`

lacheck hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.lacheck.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.latexindent`

latexindent hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.latexindent.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.latexindent.settings.flags`

Flags passed to latexindent. See available flags here

Typestring

Default"--local --silent --overwriteIfDifferent"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.lua-ls`

lua-ls hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.lua-ls.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.lua-ls.settings.checklevel`

The diagnostic check level

Typeone of "Error", "Warning", "Information", "Hint"

Default"Warning"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.lua-ls.settings.configuration`

Typeattribute set

Default{ }

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.lychee`

lychee hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.lychee.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.lychee.settings.configPath`

Path to the config file.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.lychee.settings.flags`

Flags passed to lychee. See all available here.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.markdownlint`

markdownlint hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.markdownlint.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.markdownlint.settings.configuration`

See https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc

Typeattribute set

Default{ }

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

mkdocs-linkcheck hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.mkdocs-linkcheck.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.mkdocs-linkcheck.settings.binPath`

mkdocs-linkcheck binary path. Should be used to specify the mkdocs-linkcheck binary from your Python environment.

Typenull or string or absolute path

Default

"${tools.mkdocs-linkcheck}/bin/mkdocs-linkcheck"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.mkdocs-linkcheck.settings.extension`

File extension to scan for.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.mkdocs-linkcheck.settings.local-only`

Whether to only check local links.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.mkdocs-linkcheck.settings.method`

HTTP method to use when checking external links.

Typeone of "get", "head"

Default"get"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.mkdocs-linkcheck.settings.path`

Path to check

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.mkdocs-linkcheck.settings.recurse`

Whether to recurse directories under path.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.mypy`

mypy hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.mypy.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.mypy.settings.binPath`

Mypy binary path. Should be used to specify the mypy executable in an environment containing your typing stubs.

Typenull or string

Default

"${tools.mypy}/bin/mypy"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.nbstripout`

nbstripout hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.nbstripout.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.nil`

nil hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.nil.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.nil.settings.denyWarnings`

Treat warnings like errors and exit with non-zero code

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.no-commit-to-branch.settings.branch`

Branches to disallow commits to.

Typelist of string

Default

[
  "main"
]

Example

[
  "main"
  "master"
]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.no-commit-to-branch.settings.pattern`

RegEx patterns for branch names to disallow commits to.

Typelist of string

Default[ ]

Example

[
  "ma.*"
]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.ormolu`

ormolu hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.ormolu.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.ormolu.settings.cabalDefaultExtensions`

Use default-extensions from .cabal files.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.ormolu.settings.defaultExtensions`

Haskell language extensions to enable.

Typelist of string

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.php-cs-fixer`

php-cs-fixer hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.php-cs-fixer.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.php-cs-fixer.settings.binPath`

PHP-CS-Fixer binary path.

Typenull or string

Default

"${tools.php-cs-fixer}/bin/php-cs-fixer"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.phpcbf`

phpcbf hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.phpcbf.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.phpcbf.settings.binPath`

PHP_CodeSniffer binary path.

Typenull or string

Default

"${tools.phpcbf}/bin/phpcbf"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.phpcs`

phpcs hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.phpcs.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.phpcs.settings.binPath`

PHP_CodeSniffer binary path.

Typenull or string

Default

"${tools.phpcs}/bin/phpcs"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.phpstan`

phpstan hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.phpstan.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.phpstan.settings.binPath`

PHPStan binary path.

Typenull or string

Default

"${tools.phpstan}/bin/phpstan"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.prettier`

prettier hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.prettier.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.prettier.settings.allow-parens`

Include parentheses around a sole arrow function parameter.

Typeone of "always", "avoid"

Default"always"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.prettier.settings.binPath`

prettier binary path. For example, if you want to use the prettier binary from node_modules, use "./node_modules/.bin/prettier". Use a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.

Typenull or string or absolute path

Default

"${tools.prettier}/bin/prettier"

Example

"./node_modules/.bin/prettier"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.prettier.settings.log-level`

What level of logs to report.

Typelist of string

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.proselint`

proselint hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.proselint.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.proselint.settings.config`

Multiline-string configuration passed as config file.

Typestring

Default""

Example

''
  {
    "checks": {
      "typography.diacritical_marks": false
    }
  }
''

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.proselint.settings.configPath`

Path to the config file.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.proselint.settings.flags`

Flags passed to proselint.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.psalm`

psalm hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.psalm.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.psalm.settings.binPath`

Psalm binary path.

Typenull or string

Default

"${tools.psalm}/bin/psalm"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.pylint`

pylint hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.pylint.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.pylint.settings.binPath`

Pylint binary path. Should be used to specify Pylint binary from your Python environment.

Typenull or string

Default

"${tools.pylint}/bin/pylint"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.pylint.settings.reports`

Whether to display a full report.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.pylint.settings.score`

Whether to activate the evaluation score.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.pyright`

pyright hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.pyright.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.pyright.settings.binPath`

Pyright binary path. Should be used to specify the pyright executable in an environment containing your typing stubs.

Typenull or string

Default

"${tools.pyright}/bin/pyright"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.pyupgrade`

pyupgrade hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.pyupgrade.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.pyupgrade.settings.binPath`

pyupgrade binary path. Should be used to specify the pyupgrade binary from your Python environment.

Typenull or string

Default

"${tools.pyupgrade}/bin/pyupgrade"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.regal`

regal hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.regal.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.regal.settings.flags`

Flags passed to regal. For available options run 'regal lint --help'

Typestring

Default""

Example"--disable-category style"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.reuse`

reuse hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.reuse.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.reuse.settings.flags`

`git-hooks.hooks.rumdl.settings.configuration`

See https://github.com/rvben/rumdl?tab=readme-ov-file#configuration

Typeattribute set

Default{ }

Example

{
  configuration = {
    MD013 = {
      line-length = 100;
    };
  };
}

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt`

Additional rustfmt settings

Override the rustfmt and cargo packages by setting hooks.rustfmt.packageOverrides.

hooks.rustfmt.packageOverrides.cargo = pkgs.cargo;
hooks.rustfmt.packageOverrides.rustfmt = pkgs.rustfmt;

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.rustfmt.packageOverrides.cargo`

The cargo package to use.

Typepackage

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.packageOverrides.rustfmt`

The rustfmt package to use.

Typepackage

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.all`

Format all packages, and also their local path-based dependencies

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.check`

Run rustfmt in check mode

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.color`

Coloring the output

Typeone of "auto", "always", "never"

Default"always"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.config`

Override configuration values

Typeattribute set

Default{ }

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.config-path`

Path to rustfmt.toml config file

Typenull or string

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.emit`

What data to emit and how

Typenull or one of "files", "stdout"

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.files-with-diff`

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.manifest-path`

Path to Cargo.toml

Typenull or string

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.message-format`

The output format of diagnostic messages

Typenull or one of "human", "short"

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.package`

Package(s) to check

Typelist of string matching the pattern [][*?!0-9A-Za-z_-]+

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.rustfmt.settings.verbose`

Use verbose output

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

sort-file-contents-hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.sort-file-contents.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.sort-file-contents.settings.ignore-case`

Fold lower case to upper case characters.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.sort-file-contents.settings.unique`

Ensure each line is unique.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.statix`

statix hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.statix.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.statix.settings.config`

Path to statix.toml or its parent directory.

Typenull or string

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.statix.settings.format`

Error Output format.

Typeone of "stderr", "errfmt", "json"

Default"errfmt"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.statix.settings.ignore`

Globs of file patterns to skip.

Typenull or (list of string)

Defaultnull

Example

[
  "flake.nix"
  "_*"
]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.statix.settings.unrestricted`

Don't respect .gitignore files.

Typeboolean

Defaultfalse

Exampletrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.treefmt`

Treefmt hook.

Include any additional formatters configured by treefmt as hooks.treefmt.settings.formatters.

hooks.treefmt.settings.formatters = [
  pkgs.nixpkgs-fmt
  pkgs.black
];

Override treefmt itself by setting hooks.treefmt.packageOverrides.treefmt.

hooks.treefmt.packageOverrides.treefmt = pkgs.treefmt;

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.treefmt.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.treefmt.packageOverrides.treefmt`

The treefmt package to use

Typepackage

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.treefmt.settings.fail-on-change`

Fail if some files require re-formatting.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.treefmt.settings.formatters`

The formatter packages configured by treefmt

Typelist of package

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.treefmt.settings.no-cache`

Ignore the evaluation cache entirely.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos`

typos hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.typos.settings.binary`

Whether to search binary files.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.color`

When to use generate output.

Typeone of "auto", "always", "never"

Default"auto"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.config`

Configuration as in https://github.com/crate-ci/typos/blob/master/docs/reference.md.

TypeTOML value

Default{ }

Example

{
  default = {
    binary = false;
  };
  files = {
    ignore-dot = true;
  };
  type = {
    py = {
      extend-glob = [ ];
    };
  };
}

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.configPath`

Path to a custom config file. Ignored if typos.settings.config is set.

Typestring

Default""

Example".typos.toml"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.diff`

Print a diff of what would change.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.exclude`

Ignore files and directories matching one of the globs.

Type(list of string) or string convertible to it

Default[ ]

Example

[
  "*.nix"
]

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.force-exclude`

Respect excluded files even for paths passed explicitly.

Typeboolean

Defaulttrue

Examplefalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.format`

Output format to use.

Typeone of "silent", "brief", "long", "json"

Default"long"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.hidden`

Search hidden files and directories.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.typos.settings.ignored-words`

Spellings and words to ignore.

Typelist of string

Default[ ]

Example

[
  "MQTT"
  "mosquitto"
]

`git-hooks.hooks.uv-export.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.uv-export.settings.flags`

Flags passed to uv export

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.uv-export.settings.format`

Output format of the project's lockfile.

Typeone of "requirements.txt", "pylock.toml"

Default"pylock.toml"

Example"requirements.txt"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.uv-export.settings.locked`

Assert that the uv.lock will remain unchanged. Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.vale`

vale hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.vale.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.vale.settings.configPath`

Path to the config file.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.vale.settings.configuration`

Multiline-string configuration passed as config file.

Typestring

Default""

Example

''
  MinAlertLevel = suggestion
  [*]
  BasedOnStyles = Vale
''

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.vale.settings.flags`

Flags passed to vale.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.woodpecker-cli-lint`

woodpecker-cli lint hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.woodpecker-cli-lint.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.woodpecker-cli-lint.settings.pluginsPrivileged`

List of plugins, allowed to run in privileged mode

Typestrings concatenated with ","

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.woodpecker-cli-lint.settings.pluginsTrustedClone`

List of plugins, that are trusted to handle Git credentials in cloning steps. If not set, the program defaults to "docker.io/woodpeckerci/plugin-git:2.6.3,docker.io/woodpeckerci/plugin-git,quay.io/woodpeckerci/plugin-git".

Typestrings concatenated with ","

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.woodpecker-cli-lint.settings.strict`

Whether to treat warnings as errors.

Typeboolean

Defaultfalse

Exampletrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.woodpecker-cli-lint.settings.workflowPath`

Path to the workflow config file/directory. If not set, the program looks for .woodpecker.ya?ml file or .woodpecker directory.

Typestring

Default""

Example".woodpecker.yml"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamlfmt`

yamlfmt hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamlfmt.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.yamlfmt.settings.configPath`

Path to a custom configuration file.

Typestring

Default""

Example".yamlfmt"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamlfmt.settings.lint-only`

Only lint the files, do not format them in place.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamllint`

yamllint hook

Typesubmodule

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamllint.enable`

Whether to enable this pre-commit hook.

Typeboolean

Defaultfalse

Declared ingit-hooks.nix/blob/master/modules/hook.nix

`git-hooks.hooks.yamllint.settings.configData`

Serialized YAML object describing the configuration.

Typestring

Default""

Example"{extends: relaxed, rules: {line-length: {max: 120}}}"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamllint.settings.configPath`

Path to a custom configuration file.

Typestring

Default""

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamllint.settings.configuration`

Multiline-string configuration passed as config file. If set, configuration file set in yamllint.settings.configPath gets ignored.

Typestring

Default""

Example

''
  ---
  
  extends: relaxed
  
  rules:
    indentation: enable
''

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamllint.settings.format`

Format for parsing output.

Typeone of "parsable", "standard", "colored", "github", "auto"

Default"auto"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamllint.settings.preset`

The configuration preset to use.

Typeone of "default", "relaxed"

Default"default"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.hooks.yamllint.settings.strict`

Return non-zero exit code on warnings as well as errors.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.install.enable`

Whether to enable automatic installation of pre-commit hooks.

When set to false, hooks will not be installed into the git repository, but all other module functionality (like configuration generation) will still work.

Typeboolean

Defaulttrue

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.installStages`

The stages to install the hooks to.

Typelist of (string or anything)

Default[ ]

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.installationScript`

A bash snippet that installs the git hooks in the current repository.

Typestring

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.package`

The pre-commit package to use.

Typepackage

Defaultpkgs.pre-commit

Examplepkgs.prek

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.rootSrc`

The source of the project to be checked.

This is used in the derivation that performs the check.

If you use the flakeModule, the default is self.outPath; the whole flake sources.

Typeabsolute path

DefaultgitignoreSource config.src

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.run`

A derivation that tests whether the pre-commit hooks run cleanly on the entire project.

Typepackage

Default<derivation>

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.settings.rust.cargoManifestPath`

Path to Cargo.toml

Typenull or string

Defaultnull

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.settings.rust.check.cargoDeps`

Cargo dependencies needed to run the checks.

Typenull or (attribute set)

Defaultnull

Example"pkgs.rustPlatform.importCargoLock { lockFile = ./Cargo.lock; }"

Declared ingit-hooks.nix/blob/master/modules/hooks.nix

`git-hooks.shellHook`

A shell hook that sets up the git hooks in a development shell.

Pass to mkShell as shellHook to use.

Typestring

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.src`

Root of the project. By default this will be filtered with the gitignoreSource function later, unless rootSrc is specified.

If you use the flakeModule, the default is self.outPath; the whole flake sources.

Typeabsolute path

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

`git-hooks.tools`

Tool set from which nix-pre-commit-hooks will pick binaries.

nix-pre-commit-hooks comes with its own set of packages for this purpose.

Typelazy attribute set of (null or package)

Default

git-hooks.nix-pkgs.callPackage tools-dot-nix { inherit (pkgs) system; }

Declared ingit-hooks.nix/blob/master/modules/pre-commit.nix

hosts

`hosts`

List of hosts entries.

Typeattribute set of (string or list of string)

Default{ }

Example

{
  "another-example.com" = [
    "::1"
    "127.0.0.1"
  ];
  "example.com" = "127.0.0.1";
}

Declared indevenv/blob/main/src/modules/integrations/hostctl.nix

hostsProfileName

`hostsProfileName`

Profile name to use.

Typestring

Default"devenv-<hash>"

Declared indevenv/blob/main/src/modules/integrations/hostctl.nix

infoSections

`infoSections`

Information about the environment

Typeattribute set of list of string

Default{ }

Declared indevenv/blob/main/src/modules/info.nix

inputsFrom

`inputsFrom`

A list of derivations whose build inputs will be merged into the shell environment.

Typelist of package

Default[ ]

Example

[
  pkgs.hello
  (pkgs.python3.withPackages (ps: [ ps.numpy ps.pandas ]))
]

Declared indevenv/blob/main/src/modules/top-level.nix

integrations

`integrations.gitnr`

Declarative generation of ignore files using gitnr templates.

Typeattribute set of (submodule)

Default{ }

Example

{
  ".gitignore" = {
    enableDefaultTemplates = true;
    templates = [ "tt:go" "tt:node" ];
    content = [
      "*.env"
    ];
  };
}

Declared indevenv/blob/main/src/modules/integrations/gitnr.nix

`integrations.gitnr.<name>.content`

Additional patterns to append to the generated ignore file. These patterns will be added after the templates are processed.

Typelist of string

Default[ ]

Example

[
  "*.log"
  "dist/"
]

Declared indevenv/blob/main/src/modules/integrations/gitnr.nix

`integrations.gitnr.<name>.enableDefaultTemplates`

Prepend a sensible default set of TopTal templates.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/integrations/gitnr.nix

`integrations.gitnr.<name>.package`

The gitnr package to use for generating templates.

Typepackage

Defaultpkgs.gitnr

Declared indevenv/blob/main/src/modules/integrations/gitnr.nix

`integrations.gitnr.<name>.templates`

List of templates to include in the ignore file.

Template strings are passed directly to gitnr create.

Typelist of string

Default[ ]

Example

[
  "tt:linux"
  "tt:macos"
  "tt:windows"
]

Declared indevenv/blob/main/src/modules/integrations/gitnr.nix

keyFile

`keyFile`

Custom key file name, uses mkcert default if unset

Typenull or string

Defaultnull

Example"mykey.pem"

Declared indevenv/blob/main/src/modules/integrations/mkcert.nix

languages

`languages.ansible.enable`

Whether to enable tools for Ansible development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/ansible.nix

`languages.ansible.lsp.enable`

Whether to enable Ansible Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/ansible.nix

`languages.ansible.lsp.package`

The Ansible language server package to use.

Typenull or package

Defaultpkgs.ansible-language-server

Declared indevenv/blob/main/src/modules/languages/ansible.nix

`languages.ansible.package`

The Ansible package to use.

Typepackage

Defaultpkgs.ansible

Declared indevenv/blob/main/src/modules/languages/ansible.nix

`languages.c.debugger`

An optional debugger package to use with c. The default is lldb on macOS, gdb on Linux (if supported), or null otherwise.

Typenull or package

Defaultpkgs.gdb

Declared indevenv/blob/main/src/modules/languages/c.nix

`languages.c.enable`

Whether to enable tools for C development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/c.nix

`languages.c.lsp.enable`

Whether to enable C Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/c.nix

`languages.c.lsp.package`

The C language server package to use.

Typepackage

Defaultpkgs.ccls

Declared indevenv/blob/main/src/modules/languages/c.nix

`languages.clojure.enable`

Whether to enable tools for Clojure development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/clojure.nix

`languages.clojure.lsp.enable`

Whether to enable Clojure Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/clojure.nix

`languages.clojure.lsp.package`

The Clojure language server package to use.

Typepackage

Defaultpkgs.clojure-lsp

Declared indevenv/blob/main/src/modules/languages/clojure.nix

`languages.cplusplus.enable`

Whether to enable tools for C++ development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/cplusplus.nix

`languages.cplusplus.lsp.enable`

Whether to enable C++ Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/cplusplus.nix

`languages.cplusplus.lsp.package`

The C++ language server package to use.

Typepackage

Defaultpkgs.ccls

Declared indevenv/blob/main/src/modules/languages/cplusplus.nix

`languages.crystal.enable`

Whether to enable Enable tools for Crystal development..

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/crystal.nix

`languages.crystal.lsp.enable`

Whether to enable Crystal Language Server.

`languages.cue.lsp.enable`

Whether to enable CUE Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/cue.nix

`languages.cue.lsp.package`

The CUE language server package to use.

Typepackage

Defaultpkgs.cuelsp

Declared indevenv/blob/main/src/modules/languages/cue.nix

`languages.cue.package`

The CUE package to use.

Typepackage

Defaultpkgs.cue

Declared indevenv/blob/main/src/modules/languages/cue.nix

`languages.dart.enable`

`languages.elm.lsp.package`

The Elm language server package to use.

Typepackage

Defaultpkgs.elmPackages.elm-language-server

Declared indevenv/blob/main/src/modules/languages/elm.nix

`languages.erlang.enable`

Whether to enable tools for Erlang development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/erlang.nix

`languages.erlang.lsp.enable`

Whether to enable Erlang Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/erlang.nix

`languages.erlang.lsp.package`

The Erlang language server package to use.

Typepackage

Defaultpkgs.erlang-language-platform

Declared indevenv/blob/main/src/modules/languages/erlang.nix

`languages.erlang.package`

Which Erlang package to use.

Typepackage

Defaultpkgs.beamPackages.erlang

Declared indevenv/blob/main/src/modules/languages/erlang.nix

`languages.fortran.enable`

Whether to enable tools for Fortran Development..

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/fortran.nix

`languages.fortran.lsp.enable`

Whether to enable Fortran Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/fortran.nix

`languages.fortran.lsp.package`

The Fortran language server package to use.

Typepackage

Defaultpkgs.fortls

Declared indevenv/blob/main/src/modules/languages/fortran.nix

`languages.fortran.package`

The Fortran package to use.

Typepackage

Defaultpkgs.gfortran

Declared indevenv/blob/main/src/modules/languages/fortran.nix

`languages.gawk.enable`

Whether to enable tools for GNU Awk development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/gawk.nix

`languages.gleam.enable`

Whether to enable tools for Gleam development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/gleam.nix

`languages.haskell.cabal.enable`

Additional arguments to pass to stack. By default, stack is configured to use devenv's GHC installation.

Typelist of string

Default[ "--no-nix" "--system-ghc" "--no-install-ghc" ]

Declared indevenv/blob/main/src/modules/languages/haskell.nix

`languages.haskell.stack.enable`

List of Helm plugin names to include from pkgs.kubernetes-helmPlugins.

They will be symlinked into one directory and exposed via HELM_PLUGINS.

Typelist of string

Default[ ]

Example

[
  "helm-secrets"
  "helm-diff"
  "helm-unittest"
]

Declared indevenv/blob/main/src/modules/languages/helm.nix

`languages.idris.enable`

Whether to enable tools for Idris development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/idris.nix

`languages.idris.lsp.enable`

Whether to enable Idris Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/idris.nix

`languages.idris.lsp.package`

The Idris language server package to use.

Typepackage

Defaultpkgs.idris2Packages.idris2Lsp

Declared indevenv/blob/main/src/modules/languages/idris.nix

`languages.idris.package`

The Idris package to use.

Typepackage

Defaultpkgs.idris2

Examplepkgs.idris

Declared indevenv/blob/main/src/modules/languages/idris.nix

`languages.java.enable`

Whether to enable tools for Java development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/java.nix

`languages.java.gradle.enable`

Whether to enable gradle.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/java.nix

`languages.java.gradle.package`

The Gradle package to use. The Gradle package by default inherits the JDK from languages.java.jdk.package.

Typepackage

Defaultpkgs.gradle.override { java = cfg.jdk.package; }

Declared indevenv/blob/main/src/modules/languages/java.nix

`languages.java.jdk.package`

The JDK package to use. This will also become available as JAVA_HOME.

Whether to enable bun install during devenv initialisation.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.bun.package`

The bun package to use.

Typepackage

Defaultpkgs.bun

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.corepack.enable`

Whether to enable wrappers for npm, pnpm and Yarn via Node.js Corepack.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.directory`

The JavaScript project's root directory. Defaults to the root of the devenv project. Can be an absolute path or one relative to the root of the devenv project.

Typestring

Defaultconfig.devenv.root

Example"./directory"

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.enable`

Whether to enable tools for JavaScript development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.lsp.enable`

Whether to enable TypeScript Language Server for JavaScript.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.lsp.package`

The TypeScript/JavaScript language server package to use.

Typepackage

Defaultpkgs.typescript-language-server

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.nodejs.enable`

Whether to enable Node.js runtime.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.npm.enable`

Whether to enable install npm.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.npm.install.enable`

Whether to enable npm install during devenv initialisation.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.npm.package`

The npm package to use. Defaults to the npm output of the javascript package.

Typepackage

Defaultlanguages.javascript.package

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.package`

The Node.js package to use.

Typepackage

Defaultpkgs.nodejs-slim

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.pnpm.enable`

Whether to enable install pnpm.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.pnpm.install.enable`

Whether to enable pnpm install during devenv initialisation.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.pnpm.package`

The pnpm package to use.

Typepackage

Defaultpkgs.pnpm

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.yarn.enable`

Whether to enable install yarn.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.yarn.install.enable`

Whether to enable yarn install during devenv initialisation.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.javascript.yarn.package`

The yarn package to use.

Typepackage

Defaultpkgs.yarn

Declared indevenv/blob/main/src/modules/languages/javascript.nix

`languages.jsonnet.enable`

Whether to enable tools for jsonnet development.

`languages.nix.lsp.package`

The Nix language server package to use.

Typepackage

Defaultpkgs.nixd

Declared indevenv/blob/main/src/modules/languages/nix.nix

`languages.ocaml.enable`

Whether to enable tools for OCaml development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/ocaml.nix

`languages.ocaml.lsp.enable`

Whether to enable OCaml Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/ocaml.nix

`languages.ocaml.lsp.package`

The OCaml language server package to use.

Typepackage

Defaultpkgs.ocamlPackages.ocaml-lsp

Declared indevenv/blob/main/src/modules/languages/ocaml.nix

`languages.ocaml.packages`

The package set of OCaml to use

Typeattribute set

Defaultpkgs.ocaml-ng.ocamlPackages_4_12

Declared indevenv/blob/main/src/modules/languages/ocaml.nix

`languages.odin.debugger`

An optional debugger package to use with odin. The default is gdb, if supported on the current system.

Typenull or package

Defaultpkgs.gdb

Declared indevenv/blob/main/src/modules/languages/odin.nix

`languages.odin.enable`

Whether to enable tools for Odin Language.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/odin.nix

`languages.odin.lsp.enable`

Whether to enable Odin Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/odin.nix

`languages.odin.lsp.package`

The Odin language server package to use.

Typepackage

Defaultpkgs.ols

Declared indevenv/blob/main/src/modules/languages/odin.nix

`languages.odin.package`

The odin package to use.

Typepackage

Defaultpkgs.odin

Declared indevenv/blob/main/src/modules/languages/odin.nix

`languages.opentofu.enable`

Whether to enable tools for OpenTofu development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/opentofu.nix

`languages.opentofu.lsp.enable`

Whether to enable OpenTofu Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/opentofu.nix

`languages.opentofu.lsp.package`

The OpenTofu language server package to use.

Typepackage

Defaultpkgs.terraform-ls

Declared indevenv/blob/main/src/modules/languages/opentofu.nix

The Perl language server package to use.

Typepackage

Defaultpkgs.perlnavigator

Declared indevenv/blob/main/src/modules/languages/perl.nix

`languages.perl.packages`

Perl packages to include

Typelist of string

Default[ ]

Example

[
  "Mojolicious"
]

Declared indevenv/blob/main/src/modules/languages/perl.nix

`languages.php.disableExtensions`

PHP extensions to disable.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.enable`

Whether to enable tools for PHP development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.extensions`

PHP extensions to enable.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.extraConfig`

Extra configuration that should be put in the global section of the PHP-FPM configuration file. Do not specify the options error_log or daemonize here, since they are generated by NixOS.

Typenull or strings concatenated with "\n"

Defaultnull

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.phpOptions`

Options appended to the PHP configuration file php.ini.

Typestrings concatenated with "\n"

Default""

Example

''
  date.timezone = "CET"
''

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.pools`

PHP-FPM pools. If no pools are defined, the PHP-FPM service is disabled.

Typeattribute set of (submodule)

Default{ }

Example

{
  mypool = {
    user = "php";
    group = "php";
    phpPackage = pkgs.php;
    settings = {
      "pm" = "dynamic";
      "pm.max_children" = 75;
      "pm.start_servers" = 10;
      "pm.min_spare_servers" = 5;
      "pm.max_spare_servers" = 20;
      "pm.max_requests" = 500;
    };
  }
}

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.pools.<name>.extraConfig`

Extra lines that go into the pool configuration. See the documentation on php-fpm.conf for details on configuration directives.

Typenull or strings concatenated with "\n"

Defaultnull

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.pools.<name>.listen`

The address on which to accept FastCGI requests.

Typestring

Default""

Example"/path/to/unix/socket"

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.pools.<name>.phpEnv`

Environment variables used for this PHP-FPM pool.

Typeattribute set of string

Default{ }

Example

{
  HOSTNAME = "$HOSTNAME";
  TMP = "/tmp";
  TMPDIR = "/tmp";
  TEMP = "/tmp";
}

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.pools.<name>.phpOptions`

Options appended to the PHP configuration file php.ini used for this PHP-FPM pool.

Typestrings concatenated with "\n"

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.pools.<name>.phpPackage`

The PHP package to use for running this PHP-FPM pool.

Typepackage

Defaultphpfpm.phpPackage

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.pools.<name>.settings`

PHP-FPM pool directives. Refer to the "List of pool directives" section of https://www.php.net/manual/en/install.fpm.configuration.php" the manual for details. Note that settings names must be enclosed in quotes (e.g. "pm.max_children" instead of pm.max_children).

Typeattribute set of (string or signed integer or boolean)

Default{ }

Example

{
  "pm" = "dynamic";
  "pm.max_children" = 75;
  "pm.start_servers" = 10;
  "pm.min_spare_servers" = 5;
  "pm.max_spare_servers" = 20;
  "pm.max_requests" = 500;
}

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.pools.<name>.socket`

Path to the Unix socket file on which to accept FastCGI requests.

This option is read-only and managed by NixOS.

Typestring

Exampleconfig.env.DEVENV_STATE + "/php-fpm/<name>.sock"

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.fpm.settings`

PHP-FPM global directives.

Refer to the "List of global php-fpm.conf directives" section of https://www.php.net/manual/en/install.fpm.configuration.php for details.

Note that settings names must be enclosed in quotes (e.g. "pm.max_children" instead of pm.max_children).

You need not specify the options error_log or daemonize here, since they are already set.

Typeattribute set of (string or signed integer or boolean)

Default

{
  error_log = config.env.DEVENV_STATE + "/php-fpm/php-fpm.log";
}

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.ini`

PHP.ini directives. Refer to the "List of php.ini directives" of PHP's

Typenull or strings concatenated with "\n"

Default""

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.lsp.enable`

Whether to enable PHP Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.lsp.package`

The PHP language server package to use.

Typepackage

Defaultpkgs.phpactor

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.package`

Allows you to override the default used package to adjust the settings or add more extensions. You can find the extensions using devenv search 'php extensions'

Typepackage

Defaultpkgs.php

Example

pkgs.php.buildEnv {
  extensions = { all, enabled }: with all; enabled ++ [ xdebug ];
  extraConfig = ''
    memory_limit=1G
  '';
};

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.packages`

Attribute set of packages including composer

Typesubmodule

Defaultpkgs

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.packages.composer`

composer package

Typenull or package

Defaultpkgs.phpPackages.composer

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.php.version`

The PHP version to use.

Typestring

Default""

Declared indevenv/blob/main/src/modules/languages/php.nix

`languages.pkl.enable`

Whether to enable tools for Pkl development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/pkl.nix

`languages.pkl.lsp.enable`

Whether to enable Pkl Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/pkl.nix

`languages.pkl.lsp.package`

The Pkl language server package to use.

Typepackage

Defaultpkgs.pkl-lsp

Declared indevenv/blob/main/src/modules/languages/pkl.nix

`languages.pkl.package`

The Pkl package to use.

Typepackage

Defaultpkgs.pkl

Declared indevenv/blob/main/src/modules/languages/pkl.nix

`languages.purescript.enable`

Whether to enable tools for PureScript development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/purescript.nix

`languages.purescript.lsp.enable`

Whether to enable PureScript Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/purescript.nix

`languages.purescript.lsp.package`

The PureScript language server package to use. Uses purescript-overlay by default.

Typepackage

Defaultpurescript-overlay.packages.${pkgs.stdenv.system}.purescript-language-server

Declared indevenv/blob/main/src/modules/languages/purescript.nix

`languages.purescript.package`

The PureScript compiler package to use. Uses purescript-overlay by default.

Typepackage

Defaultpurescript-overlay.packages.${pkgs.stdenv.system}.purs

Declared indevenv/blob/main/src/modules/languages/purescript.nix

`languages.purescript.spago.enable`

Whether to enable Spago package manager.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/purescript.nix

`languages.purescript.spago.package`

The Spago package manager to use. Uses purescript-overlay by default.

Typepackage

Defaultpurescript-overlay.packages.${pkgs.stdenv.system}.spago

Declared indevenv/blob/main/src/modules/languages/purescript.nix

`languages.python.directory`

The Python project's root directory. Defaults to the root of the devenv project. Can be an absolute path or one relative to the root of the devenv project.

Typestring

Defaultconfig.devenv.root

Example"./directory"

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.enable`

Whether to enable tools for Python development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.import`

Import a Python project using uv2nix.

This function takes a path to a directory containing a pyproject.toml file and returns a derivation that builds the Python project using uv2nix.

Example usage:

let
  mypackage = config.languages.python.import ./path/to/python/project {};
in {
  languages.python.enable = true;
  packages = [ mypackage ];
}

Typefunction that evaluates to a(n) function that evaluates to a(n) package

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.libraries`

Additional libraries to make available to the Python interpreter.

This is useful when you want to use Python wheels that depend on native libraries.

Typelist of absolute path

Default

[ "${config.devenv.dotfile}/profile" ]

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.lsp.enable`

Whether to enable Python Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.lsp.package`

The Python language server package to use.

Typepackage

Defaultpkgs.pyright

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.manylinux.enable`

Whether to install manylinux2014 libraries.

Enabled by default on linux;

This is useful when you want to use Python wheels that depend on manylinux2014 libraries.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.package`

The Python package to use.

Typepackage

Defaultpkgs.python3

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.patches.buildEnv.enable`

Whether to apply fixes to Python's buildEnv for correct runtime initialization:

Executables use --inherit-argv0 and --resolve-argv0 to ensure Python initializes with correct sys.prefix and sys.base_prefix
Python package scripts are unwrapped to invoke the environment's interpreter directly

Without these fixes, Python may not initialize with the correct prefix paths.

Enabled by default. Newer nixpkgs releases may include upstream fixes that make this patch obsolete.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.poetry.activate.enable`

Whether to activate the poetry virtual environment automatically.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.poetry.enable`

Whether to enable poetry.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.poetry.install.allExtras`

Whether to install all extras. See --all-extras.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.poetry.install.allGroups`

Whether to install all groups. See --all-groups.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.poetry.install.compile`

Whether poetry install should compile Python source files to bytecode.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.poetry.install.enable`

Whether to enable poetry install during devenv initialisation.

Whether to enable uv.

Whether to enable uv sync during devenv initialisation.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.uv.sync.extras`

Which extras to install. See --extra.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/languages/python

`languages.python.uv.sync.groups`

Which dependency groups to install. See --group.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/languages/python

`languages.r.lsp.enable`

Whether to enable R Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/r.nix

Whether to enable tools for Raku development.

Whether to enable tools for Ruby development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/ruby.nix

`languages.ruby.lsp.enable`

Whether to enable Ruby Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/ruby.nix

`languages.ruby.lsp.package`

The Ruby language server package to use.

Typepackage

Defaultpkgs.solargraph.override { ruby = cfg.package; }

Declared indevenv/blob/main/src/modules/languages/ruby.nix

`languages.ruby.package`

The Ruby package to use.

Typepackage

Defaultpkgs.ruby

Declared indevenv/blob/main/src/modules/languages/ruby.nix

`languages.ruby.version`

The Ruby version to use. This automatically sets the languages.ruby.package using nixpkgs-ruby.

Typenull or string

Defaultnull

Example"3.2.1"

Declared indevenv/blob/main/src/modules/languages/ruby.nix

`languages.ruby.versionFile`

The .ruby-version file path to extract the Ruby version from. This automatically sets the languages.ruby.package using nixpkgs-ruby. When the .ruby-version file exists in the same directory as the devenv configuration, you can use:

languages.ruby.versionFile = ./.ruby-version;

Typenull or absolute path

Defaultnull

Example

./.ruby-version

Declared indevenv/blob/main/src/modules/languages/ruby.nix

`languages.rust.channel`

The rustup toolchain to install.

Typeone of "nixpkgs", "stable", "beta", "nightly"

Default"nixpkgs"

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.clangLinker.enable`

Use Clang as the Rust linker driver on Linux.

This avoids GCC's collect2 wrapper, which can hit Argument list too long in large Nix development environments before the final linker receives Rust's response file.

On x86_64 Linux (glibc), Clang uses LLD unless another linker is enabled.

Typeboolean

Defaultpkgs.stdenv.hostPlatform.isLinux

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.components`

List of Rustup components to install. Defaults to those available in nixpkgs.

Typelist of string

Default[ "rustc" "cargo" "clippy" "rustfmt" "rust-analyzer" ]

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.cranelift.enable`

Use Cranelift as the codegen backend for dev builds.

Cranelift compiles significantly faster than LLVM at the cost of less optimized output. Requires the nightly channel.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.cranelift.excludePackages`

List of crate names that should use the LLVM backend instead of Cranelift.

Generates per-package overrides in .cargo/config.toml.

Typelist of string

Default[ ]

Example

[
  "aws-lc-sys"
  "aws-lc-rs"
  "rustls"
]

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.cranelift.forceBuildScriptsLlvm`

Force build scripts and proc macros to use the LLVM backend.

Some build scripts may not work with Cranelift. Enable this to fall back to LLVM for build scripts while keeping Cranelift for regular code.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.enable`

Whether to enable tools for Rust development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.import`

Import a Cargo project using crate2nix.

This function takes a path to a directory containing a Cargo.toml file and returns a derivation that builds the Rust project using crate2nix.

Example usage:

let
mypackage = config.languages.rust.import ./path/to/cargo/project {};
in {
languages.rust.enable = true;
packages = [ mypackage ];
}

Typefunction that evaluates to a(n) function that evaluates to a(n) package

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.lld.enable`

Use lld as the linker.

lld is LLVM's linker and is the recommended fast linker for Darwin. Works on both Linux and macOS.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.lsp.enable`

Whether to enable Rust Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.lsp.package`

The Rust language server package to use.

Typepackage

Default

Depends on the configured toolchain:
- `nixpkgs` channel: `pkgs.rust-analyzer`.
- non-nixpkgs channel: the `rust-analyzer` component from the rust-overlay toolchain, with a fallback to `pkgs.rust-analyzer` if not present in the manifest.
- `toolchainFile`: the aggregated toolchain package derived from the file.

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.mold.enable`

Use mold as the linker.

Path to a rust-toolchain or rust-toolchain.toml file for automatic toolchain configuration.

When set, devenv will use rust-overlay's fromRustupToolchainFile to automatically configure the toolchain based on the file contents (channel, components, targets, profile).

This follows the standard Rust toolchain file format documented at: https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file

Cannot be used together with manual channel or version configuration.

Example:

languages.rust.toolchainFile = ./rust-toolchain.toml;

Typenull or absolute path

Defaultnull

Example./rust-toolchain.toml

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.toolchainPackage`

The aggregated toolchain package, which includes the configured components and targets. This is automatically set based on the channel and components configuration.

Typepackage

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.version`

Which version of rust to use, this value could be latest,1.81.0, 2021-01-01. Only works when languages.rust.channel is NOT nixpkgs.

Typestring

Default"latest"

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.rust.wild.enable`

Use wild as the linker.

wild is a very fast linker for Linux.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/languages/rust.nix

`languages.scala.enable`

Whether to enable tools for Scala development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/scala.nix

`languages.scala.lsp.enable`

Whether to enable Scala Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/scala.nix

`languages.shell.enable`

Whether to enable tools for shell development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/shell.nix

`languages.shell.lsp.enable`

`languages.texlive.enable`

Whether to enable TeX Live.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/texlive.nix

`languages.texlive.lsp.enable`

Whether to enable TeX Live Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/texlive.nix

`languages.texlive.lsp.package`

The TeX Live language server package to use.

Typepackage

Defaultpkgs.texlab

Declared indevenv/blob/main/src/modules/languages/texlive.nix

`languages.texlive.packages`

Extra packages to add to the base TeX Live set

Typelist of string

Default[ ]

Example

[
  "algorithms"
  "latexmk"
]

Declared indevenv/blob/main/src/modules/languages/texlive.nix

`languages.typescript.enable`

Whether to enable tools for TypeScript development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/typescript.nix

`languages.typescript.lsp.enable`

Whether to enable TypeScript Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/typescript.nix

`languages.typescript.lsp.package`

The TypeScript language server package to use.

Typepackage

Defaultpkgs.typescript-language-server

Declared indevenv/blob/main/src/modules/languages/typescript.nix

`languages.typst.enable`

Whether to enable tools for Typst development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/typst.nix

`languages.typst.fontPaths`

Directories to be searched for fonts.

Typelist of string

Default[]

Example[ "${pkgs.roboto}/share/fonts/truetype" ]

Declared indevenv/blob/main/src/modules/languages/typst.nix

`languages.typst.lsp.enable`

Whether to enable Typst Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/typst.nix

Whether to enable tools for Vala development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/vala.nix

`languages.vala.lsp.enable`

Whether to enable Vala Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/vala.nix

`languages.vala.lsp.package`

The Vala language server package to use.

Typepackage

Defaultpkgs.vala-language-server

Declared indevenv/blob/main/src/modules/languages/vala.nix

`languages.vala.package`

The Vala package to use.

Typepackage

Defaultpkgs.vala

Examplepkgs.vala_0_54

Declared indevenv/blob/main/src/modules/languages/vala.nix

`languages.zig.enable`

Whether to enable tools for Zig development.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/languages/zig.nix

`languages.zig.lsp.enable`

Whether to enable Zig Language Server.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/languages/zig.nix

`languages.zig.lsp.package`

The Zig language server package to use.

Typepackage

Defaultpkgs.zls

Declared indevenv/blob/main/src/modules/languages/zig.nix

`languages.zig.package`

Which package of Zig to use.

Typepackage

Defaultpkgs.zig

Declared indevenv/blob/main/src/modules/languages/zig.nix

`languages.zig.version`

The Zig version to use. This automatically sets the languages.zig.package and languages.zig.lsp.package using zig-overlay.

Typenull or string

Defaultnull

Example"0.15.1"

Declared indevenv/blob/main/src/modules/languages/zig.nix

machines

`machines`

Machines for NixOS, home-manager, and nix-darwin.

Typeattribute set of (submodule)

Default{ }

Declared indevenv/blob/main/src/modules/machines.nix

`machines.<name>.home-manager`

Home Manager configuration for the machine.

Typenull or unspecified value

Defaultnull

Example

{
  home.username = "jdoe";
  home.homeDirectory = "/home/jdoe";
  programs.git.enable = true;
}

Declared indevenv/blob/main/src/modules/machines.nix

`machines.<name>.nix-darwin`

nix-darwin configuration for the machine.

Typenull or unspecified value

Defaultnull

Example

{ pkgs, ... }: {
  environment.systemPackages = [
    pkgs.vim
  ];
  services.nix-daemon.enable = true;
}

Declared indevenv/blob/main/src/modules/machines.nix

`machines.<name>.nixos`

NixOS configuration for the machine.

Typenull or unspecified value

Defaultnull

Example

{
  fileSystems."/".device = "/dev/sda1";
  boot.loader.systemd-boot.enable = true;
  services.openssh.enable = true;
}

Declared indevenv/blob/main/src/modules/machines.nix

`machines.<name>.system`

System architecture for the machine.

Typestring

Defaultpkgs.stdenv.system

Example"x86_64-linux"

Declared indevenv/blob/main/src/modules/machines.nix

name

`name`

Name of the project.

Typenull or string

Default"devenv-shell"

Declared indevenv/blob/main/src/modules/top-level.nix

opencode

`opencode.agents`

Custom agents (placed in .opencode/agents/).

This option can either be:

an attribute set of agents, or
a path to a directory containing agent files.

Type(attribute set of (strings concatenated with "\n" or absolute path)) or absolute path

Default{ }

Example

{
  "code-reviewer" = ''
    # Code Review Agent
    Review code for best practices and potential issues.
  '';
  "documentation-writer" = ./agents/doc-writer.md;
}

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.commands`

Custom slash commands (placed in .opencode/commands/).

This option can either be:

an attribute set of commands, or
a path to a directory containing command files.

Type(attribute set of (strings concatenated with "\n" or absolute path)) or absolute path

Default{ }

Example

{
  "fix-tests" = ''
    # Fix Tests Command
    Analyze failing tests and suggest fixes.
  '';
  "review-pr" = ./commands/review-pr.md;
}

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.enable`

Whether to enable OpenCode configuration.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.mcp`

MCP servers written to opencode.jsonc under mcp.

This option mirrors OpenCode's MCP configuration shape directly (local/remote, command, environment, url, headers, oauth, enabled, timeout, etc.).

Values from opencode.settings.mcp take precedence over this option when both define the same MCP server name.

Typeattribute set of anything

Default{ }

Example

{
  my-local = {
    type = "local";
    command = [ "devenv" "mcp" ];
    environment = {
      DEVENV_ROOT = "{env:DEVENV_ROOT}";
    };
  };

  context7 = {
    type = "remote";
    url = "https://mcp.example.com";
    headers = {
      Authorization = "Bearer TOKEN";
    };
  };
}

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.rules`

Global custom instructions (placed in .opencode/AGENTS.md).

Typestrings concatenated with "\n" or absolute path

Default""

Example

# Custom Development Rules
- Always write tests
- Use conventional commits
- Document public APIs

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.settings`

Attributes written to opencode.jsonc.

Typeattribute set of anything

Default{ }

Example

{
  editor = "nvim";
  theme = "dark";
  features = {
    autocomplete = true;
    git_integration = true;
  };
}

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.skills`

Custom skills for opencode.

This option can either be:

an attribute set defining skills, or
a path to a directory containing skill folders.

If an attribute set is used, each value can be:

inline content (creates .opencode/skills/<name>/SKILL.md)
a path to a file (creates .opencode/skills/<name>/SKILL.md)
a path to a directory (creates .opencode/skills/<name>/)

Type(attribute set of (strings concatenated with "\n" or absolute path or string)) or absolute path

Default{ }

Example

{
  "debug-helper" = ''
    # Debug Helper Skill
    Helps diagnose and fix bugs systematically.
  '';
  "api-generator" = ./skills/api-generator.md;
  "full-stack-skill" = ./skills/full-stack;
}

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.themes`

Custom themes for opencode.

This option can either be:

an attribute set defining themes, or
a path to a directory containing theme files.

Type(attribute set of ((attribute set of anything) or absolute path)) or absolute path

Default{ }

Example

{
  my-theme = {
    colors = {
      background = "#0f1115";
      foreground = "#d6d9e0";
    };
  };
  custom = ./themes/custom.json;
}

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.tools`

Custom tools for opencode.

This option can either be:

an attribute set defining tools, or
a path to a directory containing tool files.

Type(attribute set of (strings concatenated with "\n" or absolute path)) or absolute path

Default{ }

Example

{
  sample = "export default { name: \"sample-tool\"; };";
  lint = ./tools/lint.ts;
}

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.web.enable`

Whether to enable opencode web service.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

`opencode.web.extraArgs`

Extra arguments to pass to opencode web.

These arguments override web server options in the configuration file.

Typelist of string

Default[ ]

Example

[
  "--hostname"
  "127.0.0.1"
  "--port"
  "4096"
]

Declared indevenv/blob/main/src/modules/integrations/opencode.nix

outputs

`outputs`

Nix outputs for devenv build consumption.

TypeoutputOf (attribute set)

Default{ }

Example

{
  git = pkgs.git;
  foo = {
    ncdu = pkgs.ncdu;
  };
}

Declared indevenv/blob/main/src/modules/outputs.nix

overlays

`overlays`

List of overlays to apply to pkgs. Each overlay is a function that takes two arguments: final and prev. Supported by devenv 1.4.2 or newer.

Typelist of function that evaluates to a(n) function that evaluates to a(n) (attribute set)

Default[ ]

Example

[
  (final: prev: {
    hello = prev.hello.overrideAttrs (oldAttrs: {
      patches = (oldAttrs.patches or []) ++ [ ./hello-fix.patch ];
    });
  })
]

Declared indevenv/blob/main/src/modules/top-level.nix

packages

`packages`

A list of packages to expose inside the developer environment. Search available packages using devenv search NAME.

Typelist of package

Default[ ]

Declared indevenv/blob/main/src/modules/top-level.nix

process

`process.manager.adapter.client`

Client protocol used for attach, readiness, and individual process control.

Typeone of "none", "native-api"

Declared indevenv/blob/main/src/modules/processes.nix

`process.manager.adapter.stop`

Adapter used to stop the running manager.

Typeone of "native-api", "command", "process-scope"

Declared indevenv/blob/main/src/modules/processes.nix

`process.manager.adapter.terminal`

Terminal required by the manager launcher.

Typeone of "none", "controlling"

Declared indevenv/blob/main/src/modules/processes.nix

`process.manager.after`

Bash code to execute after stopping processes.

Typestrings concatenated with "\n"

Default""

Declared indevenv/blob/main/src/modules/processes.nix

`process.manager.args`

Additional arguments to pass to the process manager.

Typeattribute set

Declared indevenv/blob/main/src/modules/processes.nix

`process.manager.before`

Bash code to execute before starting processes.

The process manager to use when running processes with devenv up.

Typeone of "hivemind", "honcho", "mprocs", "native", "overmind", "process-compose"

`process.managers.honcho.package`

The honcho package to use.

`process.managers.mprocs.settings`

Top-level mprocs.yaml options

https://github.com/pvolok/mprocs?tab=readme-ov-file#config

`process.managers.process-compose.package`

The process-compose package to use.

Typepackage

Defaultpkgs.process-compose

Declared indevenv/blob/main/src/modules/process-managers/process-compose.nix

`process.managers.process-compose.port`

The port to bind the process-compose server to.

Not used when unixSocket.enable is true.

Typesigned integer

Default8080

Declared indevenv/blob/main/src/modules/process-managers/process-compose.nix

`process.managers.process-compose.settings`

Top-level process-compose.yaml options

Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml

TypeYAML 1.1 value

Default{ }

Example

{
  availability = {
    backoff_seconds = 2;
    max_restarts = 5;
    restart = "on_failure";
  };
  depends_on = {
    some-other-process = {
      condition = "process_completed_successfully";
    };
  };
  environment = [
    "ENVVAR_FOR_THIS_PROCESS_ONLY=foobar"
  ];
}

Declared indevenv/blob/main/src/modules/process-managers/process-compose.nix

`process.managers.process-compose.tui.enable`

Enable the TUI (Terminal User Interface)

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/process-managers/process-compose.nix

`process.managers.process-compose.unixSocket.enable`

Whether to enable running the process-compose server over unix domain sockets instead of tcp.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/process-managers/process-compose.nix

`process.managers.process-compose.unixSocket.path`

Override the path to the unix socket.

Typestring

Default${config.devenv.runtime}/pc.sock

Declared indevenv/blob/main/src/modules/process-managers/process-compose.nix

`process.proxy.enable`

Whether to enable the shared HTTP proxy for friendly process URLs under .localhost .

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/integrations/process-proxy.nix

processes

`processes`

Processes can be started with devenv up and run in the foreground.

Typeattribute set of (submodule)

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.after`

Tasks that must be ready before this process starts. Use task names like "devenv:processes:postgres" or "myapp:setup". Supports @started, @ready (default for processes), and @completed suffixes for process dependencies. Supports @started, @succeeded (default for tasks), and @completed suffixes for task dependencies.

Typelist of string

Default[ ]

Example

[
  "devenv:processes:postgres"
  "myapp:migrations@succeeded"
]

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.before`

Tasks that should start after this process is ready.

Typelist of string

Default[ ]

Example

[
  "devenv:processes:nginx"
]

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.cwd`

Working directory to run the process in. If not specified, the current working directory will be used.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.env`

Environment variables to set for this process.

Typeattribute set of string

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.exec`

Bash code to run the process.

Typestring

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.linux`

Linux-specific process configuration.

Requires devenv 2.0+.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.linux.capabilities`

Linux capabilities to add as ambient capabilities for this process (e.g., "net_bind_service", "net_admin").

Supported capabilities are net_bind_service, net_raw, net_admin, ipc_lock, sys_nice, sys_resource, sys_admin, chown, dac_override, and fowner. Starting a process with capabilities requires sudo authentication.

Requires devenv 2.0+.

Typelist of string

Default[ ]

Example

[
  "net_bind_service"
  "net_admin"
]

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.listen`

Socket activation configuration for systemd-style socket passing.

Requires devenv 2.0+.

Typelist of (submodule)

Default[ ]

Example

[
  {
    address = "127.0.0.1:8080";
    kind = "tcp";
    name = "http";
  }
  {
    kind = "unix_stream";
    mode = 384;
    name = "admin";
    path = "$DEVENV_STATE/admin.sock";
  }
]

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.listen.*.address`

TCP address (e.g., '127.0.0.1:8080'). Required for TCP sockets.

Named ports with auto-allocation for this process.

Define ports with a base value and devenv will automatically find a free port starting from that base, incrementing until available.

The resolved port is available via config.processes.<name>.ports.<port>.value.

Requires devenv 2.0+.

Typeattribute set of (submodule)

Default{ }

Example

{
  http.allocate = 8080;
  admin.allocate = 9000;
}

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ports.<name>.allocate`

Base port for auto-allocation (increments until free)

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Example8080

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ports.<name>.proxy`

Shared HTTP proxy configuration for this port.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ports.<name>.proxy.hostname`

Full .localhost hostname to use for this port when process.proxy.enable is enabled.

This takes precedence over processes.<name>.proxy.hostname and the generated hostname.

Typenull or string

Defaultnull

Example"admin.localhost"

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ports.<name>.value`

Resolved port value (allocated by devenv)

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

DefaultAllocated port based on `allocate`

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.process-compose`

process-compose.yaml specific process attributes.

Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml

Only used when using process.manager.implementation = "process-compose";

TypeYAML 1.1 value

Default{ }

Example

{
  availability = {
    backoff_seconds = 2;
    max_restarts = 5;
    restart = "on_failure";
  };
  depends_on = {
    some-other-process = {
      condition = "process_completed_successfully";
    };
  };
  environment = [
    "ENVVAR_FOR_THIS_PROCESS_ONLY=foobar"
  ];
}

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.proxy`

Shared HTTP proxy configuration for this process.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.proxy.hostname`

Full .localhost hostname to use for this process when process.proxy.enable is enabled.

By default, devenv derives the hostname from the process and project names. Named ports without their own hostname override are prefixed to this hostname.

Typenull or string

Defaultnull

Example"app.localhost"

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.proxy.https.enable`

Whether to enable HTTPS proxy URLs for this process using the project's mkcert certificate authority. HTTP URLs remain available. Requires process.proxy.enable .

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready`

How to determine if this process is ready to serve.

Requires devenv 2.0+.

Typenull or (submodule)

Defaultnull

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.exec`

Shell command to execute. Exit 0 = ready.

Typenull or string

Defaultnull

Example"pg_isready -d template1"

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.failure_threshold`

Consecutive failures before marking unhealthy.

Typesigned integer

Default3

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.http`

HTTP readiness probe configuration.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.http.get`

HTTP GET readiness check.

Typenull or (submodule)

Defaultnull

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.http.get.host`

Host to connect to.

Typestring

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.http.get.path`

HTTP path to request.

Typestring

Default"/"

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.http.get.port`

Port to connect to.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.http.get.scheme`

URL scheme (http or https).

Typestring

Default"http"

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.initial_delay`

Seconds to wait before first probe.

Typesigned integer

Default0

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.notify`

Enable systemd notify protocol for readiness signaling. The process must send READY=1 to the NOTIFY_SOCKET.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.period`

Seconds between probes.

Typesigned integer

Default10

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.probe_timeout`

Seconds before a single probe times out.

Typesigned integer

Default1

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.success_threshold`

Consecutive successes needed to be considered ready.

Typesigned integer

Default1

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.ready.timeout`

Overall deadline in seconds for the process to become ready. null = no deadline.

Typenull or (unsigned integer, meaning >=0)

Defaultnull

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.restart`

Process restart policy.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.restart.max`

Maximum restart attempts. null = unlimited.

Typenull or signed integer

Default5

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.restart.on`

When to restart: never, always, or on_failure.

Typeone of "never", "always", "on_failure"

Default"on_failure"

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.restart.window`

Sliding window in seconds for restart rate limiting. null = lifetime limit.

Typenull or (unsigned integer, meaning >=0)

Defaultnull

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.shutdown`

Graceful shutdown signal and timeout

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.shutdown.grace`

Seconds before shutdown escalates to SIGKILL

Typeunsigned integer, meaning >=0

Default5

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.shutdown.signal`

Unix signal number used for graceful shutdown

Typeinteger between 1 and 31 (both inclusive)

Default15

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.start`

Auto-start configuration for this process.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.start.enable`

Whether to start this process automatically with devenv up.

Disabled processes are still visible in the TUI as stopped and can be started manually by selecting them and pressing Enter. They also run when pulled in as a task dependency, for example after = [ "devenv:processes:<name>@completed" ].

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.watch`

File watching configuration for automatic process restarts.

Requires devenv 2.0+.

Typesubmodule

Default{ }

Example

{
  paths = [ ./src ];
  extensions = [ "rs" "toml" ];
  ignore = [ "target" ];
}

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.watch.extensions`

File extensions to watch (e.g., "rs", "js", "py"). If empty, all file extensions are watched.

Requires devenv 2.0+.

Typelist of string

Default[ ]

Example

[
  "rs"
  "toml"
]

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.watch.ignore`

Glob patterns to ignore (e.g., ".git", "target", "*.log").

Requires devenv 2.0+.

Typelist of string

Default[ ]

Example

[
  "*.log"
  ".git"
  "target"
]

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.watch.paths`

Paths to watch for changes (files or directories). When files in these paths change, the process is restarted (or, for a one-shot command that exits immediately, re-run).

Paths are resolved relative to the location of devenv.nix (the project root), not relative to the process's cwd. Use path literals such as ./src; they are passed to the watcher as absolute paths.

Requires devenv 2.0+.

Typelist of absolute path

Default[ ]

Example

[ ./src ./config.yaml ]

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.watchdog`

Systemd watchdog configuration.

Requires devenv 2.0+.

Typenull or (submodule)

Defaultnull

Example

{
  usec = 30000000; # 30 seconds
  require_ready = true;
}

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.watchdog.require_ready`

Require READY=1 notification before enforcing watchdog

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/processes.nix

`processes.<name>.watchdog.usec`

Watchdog interval in microseconds

Typesigned integer

Declared indevenv/blob/main/src/modules/processes.nix

profiles

`profiles`

Profile definitions that can be activated manually or automatically.

Typeopen submodule of lazy attribute set of (submodule)

Default{ }

Example

{
  # Manual profiles (activated via --profile)
  "base" = {
    module = {
      languages.nix.enable = true;
      packages = [ pkgs.git ];
    };
  };
  "python-3.14" = {
    extends = [ "base" ];
    module = {
      languages.python.version = "3.14";
    };
  };
  "backend" = {
    extends = [ "base" ];
    module = {
      services.postgres.enable = true;
      services.redis.enable = true;
    };
  };
  "fullstack" = {
    extends = [ "backend" "python-3.14" ];
    module = {
      env.FULL_STACK = "true";
    };
  };
  # Automatic hostname-based profiles
  hostname."work-laptop" = {
    extends = [ "backend" ];
    module = {
      env.WORK_ENV = "true";
    };
  };
  # Automatic user-based profiles
  user."alice" = {
    extends = [ "python-3.14" ];
    module = {
      env.USER_ROLE = "developer";
    };
  };
}

Declared indevenv/blob/main/src/modules/profiles.nix

`profiles.<name>.extends`

List of profile names to extend/inherit from.

Typelist of string

Default[ ]

Example

[
  "base"
  "backend"
]

`profiles.<name>.module`

Additional configuration to merge when this profile is active.

Typemodule

Default{ }

`profiles.hostname`

Profile definitions that are automatically activated based on the machine's hostname.

Typelazy attribute set of (submodule)

Default{ }

Declared indevenv/blob/main/src/modules/profiles.nix

`profiles.hostname.<name>.extends`

List of profile names to extend/inherit from.

Typelist of string

Default[ ]

Example

[
  "base"
  "backend"
]

Declared indevenv/blob/main/src/modules/profiles.nix

`profiles.hostname.<name>.module`

Additional configuration to merge when this profile is active.

Typemodule

Default{ }

Declared indevenv/blob/main/src/modules/profiles.nix

`profiles.user`

Profile definitions that are automatically activated based on the username.

Typelazy attribute set of (submodule)

Default{ }

Declared indevenv/blob/main/src/modules/profiles.nix

`profiles.user.<name>.extends`

List of profile names to extend/inherit from.

Typelist of string

Default[ ]

Example

[
  "base"
  "backend"
]

Declared indevenv/blob/main/src/modules/profiles.nix

`profiles.user.<name>.module`

Additional configuration to merge when this profile is active.

Typemodule

Default{ }

Declared indevenv/blob/main/src/modules/profiles.nix

scripts

`scripts`

A set of scripts available when the environment is active.

Typeattribute set of (submodule)

Default{ }

Declared indevenv/blob/main/src/modules/scripts.nix

`scripts.<name>.binary`

Override the binary name from the default package.meta.mainProgram

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/scripts.nix

`scripts.<name>.description`

Description of the script.

Typestring

Default""

Declared indevenv/blob/main/src/modules/scripts.nix

`scripts.<name>.exec`

Shell code to execute when the script is run, or path to a script file.

Typestring or absolute path

Declared indevenv/blob/main/src/modules/scripts.nix

`scripts.<name>.package`

The package to use to run the script.

Typepackage

Defaultpkgs.bash

Declared indevenv/blob/main/src/modules/scripts.nix

`scripts.<name>.packages`

Packages to be available in PATH when the script runs.

Typelist of package

Default[]

Declared indevenv/blob/main/src/modules/scripts.nix

secretspec

`secretspec.enable`

Whether secretspec integration is enabled (automatically true when secrets are loaded)

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/integrations/secretspec.nix

`secretspec.profile`

The secretspec profile that was used to load secrets (read-only)

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/secretspec.nix

`secretspec.provider`

The explicit secretspec provider override selected through devenv, if any (read-only)

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/integrations/secretspec.nix

`secretspec.secrets`

Secrets loaded from secretspec.toml (read-only)

Typeattribute set of string

Default{ }

Declared indevenv/blob/main/src/modules/integrations/secretspec.nix

services

`services.adminer.enable`

Whether to enable Adminer process.

Declared indevenv/blob/main/src/modules/services/blackfire.nix

`services.blackfire.enableApm`

Whether to enable Enables application performance monitoring, requires special subscription. .

`services.caddy.ca`

Certificate authority ACME server. The default (Let's Encrypt production server) should be fine for most people. Set it to null if you don't want to include any authority (or if you want to write a more fine-graned configuration manually).

Typenull or string

Default"https://acme-v02.api.letsencrypt.org/directory"

Example"https://acme-staging-v02.api.letsencrypt.org/directory"

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.config`

Verbatim Caddyfile to use.

Refer to https://caddyserver.com/docs/caddyfile for more information.

Caddy v2 supports multiple config formats via adapters (see services.caddy.adapter).

Typestrings concatenated with "\n"

Default""

Example

''
  # Global options block
  {
    debug
  }
  
  # Site block
  example.com {
    encode gzip
    log
    root /srv/http
  }
''

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.dataDir`

The data directory, for storing certificates. Before 17.09, this would create a .caddy directory. With 17.09 the contents of the .caddy directory are in the specified data directory instead. Caddy v2 replaced CADDYPATH with XDG directories. See https://caddyserver.com/docs/conventions#file-locations.

Typeabsolute path

Default"${config.env.DEVENV_STATE}/caddy"

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.email`

Email address (for Let's Encrypt certificate).

Typestring

Default""

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.enable`

Whether to enable Caddy web server.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.package`

Caddy package to use.

Typepackage

Defaultpkgs.caddy

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.resume`

Use saved config, if any (and prefer over configuration passed with caddy.config).

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.virtualHosts`

Declarative vhost config.

Typeattribute set of (submodule)

Default{ }

Example

{
  "hydra.example.com" = {
    serverAliases = [ "www.hydra.example.com" ];
    extraConfig = ''''
      encode gzip
      log
      root /srv/http
    '''';
  };
};

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.virtualHosts.<name>.extraConfig`

These lines go into the vhost verbatim.

Typestrings concatenated with "\n"

Default""

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.caddy.virtualHosts.<name>.serverAliases`

Additional names of virtual hosts served by this virtual host configuration.

Typelist of string

Default[ ]

Example

[
  "www.example.org"
  "example.org"
]

Declared indevenv/blob/main/src/modules/services/caddy.nix

`services.cassandra.allowClients`

Enables or disables the native transport server (CQL binary protocol)

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/cassandra.nix

`services.cassandra.clusterName`

The name of the cluster

Typestring

Default"Test Cluster"

Declared indevenv/blob/main/src/modules/services/cassandra.nix

`services.cassandra.enable`

Whether to enable Add Cassandra process script..

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/cassandra.nix

`services.cassandra.extraConfig`

Extra options to be merged into cassandra.yaml as nix attribute set.

Typeattribute set

Default{ }

Example

{
  commitlog_sync_batch_window_in_ms = 3;
}

Declared indevenv/blob/main/src/modules/services/cassandra.nix

`services.cassandra.jvmOpts`

Options to pass to the JVM through the JVM_OPTS environment variable

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/services/cassandra.nix

`services.cassandra.listenAddress`

Listen address

Typestring

Default"127.0.0.1"

Example"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/cassandra.nix

`services.cassandra.package`

Which version of Cassandra to use

Typepackage

Defaultpkgs.cassandra_4

Examplepkgs.cassandra_4;

Declared indevenv/blob/main/src/modules/services/cassandra.nix

`services.cassandra.seedAddresses`

The addresses of hosts designated as contact points of the cluster

Typelist of string

Default

[
  "127.0.0.1"
]

Declared indevenv/blob/main/src/modules/services/cassandra.nix

`services.clickhouse.config`

ClickHouse configuration in YAML.

Typestrings concatenated with "\n"

Declared indevenv/blob/main/src/modules/services/clickhouse.nix

`services.clickhouse.enable`

Whether to enable clickhouse-server.

Your users.yaml as a Nix attribute set. Check the documentation for possible options.

TypeYAML 1.1 value

Default{ }

Example

{
  profiles = {};

  users = {
    default = {
      profile = "default";
      password_sha256_hex = "36dd292533174299fb0c34665df468bb881756ca9eaf9757d0cfde38f9ededa1";  # `echo -n verysecret | sha256sum`
    };
  };
}

Declared indevenv/blob/main/src/modules/services/clickhouse.nix

`services.cockroachdb.enable`

Whether to enable Add CockroachDB process. .

`services.couchdb.package`

Which version of CouchDB to use

Typepackage

Defaultpkgs.couchdb3

Declared indevenv/blob/main/src/modules/services/couchdb.nix

`services.couchdb.settings`

CouchDB configuration. To learn more about all settings, see the CouchDB configuration reference.

Typeopen submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default{ }

Example

{
  couchdb = {
    database_dir = baseDir;
    single_node = true;
    view_index_dir = baseDir;
    uri_file = "${config.services.couchdb.baseDir}/couchdb.uri";
  };
  admins = {
    "admin_username" = "pass";
  };
  chttpd = {
    bind_address = "127.0.0.1";
    port = 5984;
  };
}

Declared indevenv/blob/main/src/modules/services/couchdb.nix

`services.dynamodb-local.enable`

Whether to enable DynamoDB Local.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/dynamodb-local.nix

`services.dynamodb-local.package`

Which package of DynamoDB to use.

Typepackage

Defaultpkgs.dynamodb-local

Declared indevenv/blob/main/src/modules/services/dynamodb-local.nix

`services.dynamodb-local.port`

Listen port for DynamoDB Local.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default8000

Declared indevenv/blob/main/src/modules/services/dynamodb-local.nix

`services.dynamodb-local.sharedDb`

If true, enables the -sharedDb flag for DynamoDB Local. When enabled, DynamoDB Local creates a single database file named shared-local-instance.db. Every program that connects to DynamoDB accesses this file. If you delete the file, you lose any data stored in it.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/dynamodb-local.nix

`services.elasticmq.enable`

Whether to enable elasticmq-server.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/elasticmq.nix

`services.elasticmq.package`

Which package of elasticmq-server-bin to use

Typepackage

Defaultpkgs.elasticmq-server-bin

Declared indevenv/blob/main/src/modules/services/elasticmq.nix

`services.elasticmq.settings`

Configuration for elasticmq-server

Typestrings concatenated with "\n"

Default""

Declared indevenv/blob/main/src/modules/services/elasticmq.nix

`services.elasticsearch.cluster_name`

Elasticsearch name that identifies your cluster for auto-discovery.

Typestring

Default"elasticsearch"

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.enable`

Whether to enable elasticsearch.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.extraCmdLineOptions`

Extra command line options for the elasticsearch launcher.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.extraConf`

Extra configuration for elasticsearch.

Typestring

Default""

Example

''
  node.name: "elasticsearch"
  node.master: true
  node.data: false
''

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.extraJavaOptions`

Extra command line options for Java.

Typelist of string

Default[ ]

Example

[
  "-Djava.net.preferIPv4Stack=true"
]

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.listenAddress`

Elasticsearch listen address.

Typestring

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.logging`

Elasticsearch logging configuration.

Typestring

Default

''
  logger.action.name = org.elasticsearch.action
  logger.action.level = info
  appender.console.type = Console
  appender.console.name = console
  appender.console.layout.type = PatternLayout
  appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n
  rootLogger.level = info
  rootLogger.appenderRef.console.ref = console
''

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.package`

Elasticsearch package to use.

Typepackage

Defaultpkgs.elasticsearch7

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.plugins`

Extra elasticsearch plugins

Typelist of package

Default[ ]

Example[ pkgs.elasticsearchPlugins.discovery-ec2 ]

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.port`

Elasticsearch port to listen for HTTP traffic.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default9200

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.single_node`

Start a single-node cluster

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.elasticsearch.tcp_port`

Elasticsearch port for the node to node communication.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default9300

Declared indevenv/blob/main/src/modules/services/elasticsearch.nix

`services.garage.adminAddress`

IP address and port of the admin API.

Typestring

Default"127.0.0.1:3903"

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.adminToken`

Admin API bearer token. Hard-coded for single-node dev; production deployments override this with a real secret.

Typestring

Default"devtoken"

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.afterStart`

Bash code to execute after the server is running and the cluster layout is applied. The garage CLI in scope already points at the local instance via the generated config.

Typestrings concatenated with "\n"

Default""

Example

''
  garage key new --name app-key
  garage bucket allow --read --write --owner my-bucket --key app-key
''

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.buckets`

List of buckets to ensure exist on startup.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.enable`

Whether to enable Garage S3-compatible object storage.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.extraConfig`

Additional garage.toml snippet appended to the generated config.

Typestrings concatenated with "\n"

Default""

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.package`

Garage package to use.

Typepackage

Defaultpkgs.garage_2

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.region`

S3 region label reported by the server. Defaults to AWS's canonical us-east-1.

Typestring

Default"us-east-1"

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.replicationFactor`

Cluster replication factor. Single-node devenv setups always use 1.

Typesigned integer

Default1

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.rpcSecret`

RPC secret as 64 hex characters. Hard-coded for single-node dev; production deployments override this with a real secret.

Typestring

Default"0000000000000000000000000000000000000000000000000000000000000000"

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.s3Address`

IP address and port of the S3 API.

Typestring

Default"127.0.0.1:3900"

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.ui.enable`

Whether to enable a simple web UI.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.ui.port`

On which port the UI should run.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default3919

Example3919

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.garage.ui.start`

Whether to start the web UI automatically. When false it can be started manually. Only applies when ui.enable = true.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/garage.nix

`services.httpbin.bind`

Addresses for httpbin to listen on.

Typelist of string

Default

[
  "127.0.0.1:8080"
]

Declared indevenv/blob/main/src/modules/services/httpbin.nix

`services.httpbin.enable`

Whether to enable httpbin.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/httpbin.nix

`services.httpbin.extraArgs`

Gunicorn CLI arguments for httpbin.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/services/httpbin.nix

`services.influxdb.enable`

Whether to enable influxdb.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/influxdb.nix

`services.influxdb.extraArgs`

Additional arguments passed to influxd during startup.

Typelist of string

Default[ ]

Example

[
  "--flux-log-enabled"
]

Declared indevenv/blob/main/src/modules/services/influxdb.nix

`services.influxdb.package`

Which package of InfluxDB server to use

Typepackage

Defaultpkgs.influxdb2-server

Declared indevenv/blob/main/src/modules/services/influxdb.nix

`services.influxdb.port`

The TCP port for the InfluxDB HTTP API.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default8086

Declared indevenv/blob/main/src/modules/services/influxdb.nix

`services.kafka.configFiles.log4jProperties`

Kafka log4j property configuration file path

Typeabsolute path

Default"pkgs.writeText \"log4j.properties\" cfg.log4jProperties"

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.configFiles.serverProperties`

Kafka server.properties configuration file path. Defaults to the rendered settings.

Typeabsolute path

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.connect.enable`

Whether to enable Kafka Connect.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.initialConnectors`

List of Kafka Connect connectors to set up initially

Typelist of (open submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string)))

Default[ ]

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.initialConnectors.*.config`

Initial configuration for the connector

Typeattribute set

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.initialConnectors.*.name`

Name of the connector

Typestring

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings`

{file}connect-standalone.properties.

Note that .properties files contain mappings from string to string. Keys with dots are NOT represented by nested attrs in these settings, but instead as quoted strings (ie. settings."broker.id", NOT settings.broker.id).

Typeopen submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string))

Default{ }

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings."bootstrap.servers"`

A list of host/port pairs to use for establishing the initial connection to the Kafka cluster.

Typelist of string

Default

[
  "localhost:9092"
]

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings."key.converter"`

The key converter to use for the connector.

Typestring

Default"org.apache.kafka.connect.json.JsonConverter"

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings."key.converter.schemas.enable"`

Whether the key converter should include schema information in the message.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings."offset.flush.interval.ms"`

Interval at which to try committing offsets for tasks

Typesigned integer

Default10000

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings."offset.storage.file.filename"`

The file to store connector offsets in. By storing offsets on disk, a standalone process can be stopped and started on a single node and resume where it previously left off.

Typestring

Default${config.env.DEVENV_STATE}/kafka/connect/connect.offsets

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings."plugin.path"`

The list should consist of top level directories that include any combination of: a) directories immediately containing jars with plugins and their dependencies b) uber-jars with plugins and their dependencies c) directories immediately containing the package directory structure of classes of plugins and their dependencies Note: symlinks will be followed to discover dependencies or plugins.

Typenull or (list of (string or absolute path))

Defaultnull

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings."value.converter"`

The value converter to use for the connector.

Typestring

Default"org.apache.kafka.connect.json.JsonConverter"

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings."value.converter.schemas.enable"`

Whether the value converter should include schema information in the message.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.connect.settings.listeners`

List of listeners for Kafka Connect (By default Kafka Connect listens on http://localhost:8083)

Typenull or (list of string)

Defaultnull

Example

[
  "http://localhost:8080"
]

Declared indevenv/blob/main/src/modules/services/kafka-connect.nix

`services.kafka.defaultMode`

Which defaults to set for the mode Kafka should run in

kraft (default): Run Kafka in KRaft mode, Which requires no extra configuration.
zookeeper: Run Kafka in Zookeeper mode, this requires more configuration.

Typeone of "zookeeper", "kraft"

Default"kraft"

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.enable`

Whether to enable Apache Kafka.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.formatLogDirs`

Whether to format log dirs in KRaft mode if all log dirs are unformatted, ie. they contain no meta.properties.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.formatLogDirsIgnoreFormatted`

Whether to ignore already formatted log dirs when formatting log dirs, instead of failing. Useful when replacing or adding disks.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.jre`

The JRE with which to run Kafka

Typepackage

Defaultpkgs.apacheKafka.passthru.jre

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.jvmOptions`

Extra command line options for the JVM running Kafka.

Typelist of string

Default[ ]

Example

[
  "-Djava.net.preferIPv4Stack=true"
  "-Dcom.sun.management.jmxremote"
  "-Dcom.sun.management.jmxremote.local.only=true"
]

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.log4jProperties`

Kafka log4j property configuration.

Typestrings concatenated with "\n"

Default

''
  log4j.rootLogger=INFO, stdout
  
  log4j.appender.stdout=org.apache.log4j.ConsoleAppender
  log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
  log4j.appender.stdout.layout.ConversionPattern=[%d] %p %m (%c)%n
''

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.package`

The apacheKafka package to use.

Typepackage

Defaultpkgs.apacheKafka

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.settings`

Kafka broker configuration {file}server.properties.

Typeopen submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string))

Default{ }

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.settings."broker.id"`

Broker ID. -1 or null to auto-allocate in zookeeper mode.

Typenull or signed integer

Defaultnull

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.settings."log.dirs"`

Log file directories.

Typelist of absolute path

Default[ "${config.devenv.state + "/kafka"}/logs" ]

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.kafka.settings.listeners`

Kafka Listener List. See listeners. If you change this, you should also update the readiness probe.

Typelist of string

Default

[
  "PLAINTEXT://localhost:9092"
]

Declared indevenv/blob/main/src/modules/services/kafka.nix

`services.keycloak.database.type`

The type of database Keycloak should connect to. If you use dev-mem, the realm export over script keycloak-realm-export-* does not work.

Typeone of "dev-mem", "dev-file"

Default"dev-file"

Example"dev-mem"

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.enable`

Whether to enable the Keycloak identity and access management server.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.initialAdminPassword`

Initial password set for the temporary admin user. The password is not stored safely and should be changed immediately in the admin panel.

See Admin bootstrap and recovery for details.

Typestring

Default"admin"

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.package`

The keycloak package to use.

Typepackage

Defaultpkgs.keycloak

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.plugins`

Keycloak plugin jar, ear files or derivations containing them. Packaged plugins are available through pkgs.keycloak.plugins.

Typelist of absolute path

Default[ ]

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.processes.exportRealms`

Global toggle to enable/disable the realms export process keycloak-realm-export-all if any realms have realms.«name».export == true.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.realms`

Specify the realms you want to import on start up and export on a manual start of process/script 'keycloak-realm-export-all'.

Typeattribute set of (submodule)

Default{ }

Example

{
  myrealm = {
    path = "./myfolder/export.json";
    import = true; # default
    export = true;
  };
}

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.realms.<name>.export`

If you want to export that realm on process/script launch keycloak-export-realms.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.realms.<name>.import`

If you want to import that realm on start up, if the realm does not yet exist.

Typeboolean

Defaulttrue

Exampletrue

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.realms.<name>.path`

The path (string, relative to DEVENV_ROOT) where you want to import (or export) this realm «name» to. If not set and import is true this realm is not imported. If not set and export is true its exported to $DEVENV_STATE/keycloak/realm-export/«name».json.

Typenull or relative path not in the Nix store

Defaultnull

Example"./realms/a.json"

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.scripts.exportRealm`

Global toggle to enable/disable the single realm export script keycloak-realm-export.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.settings`

Configuration options corresponding to parameters set in {file}conf/keycloak.conf.

Most available options are documented at https://www.keycloak.org/server/all-config.

Options containing secret data should be set to an attribute set containing the attribute _secret - a string pointing to a file containing the value the option should be set to. See the example to get a better picture of this: in the resulting {file}conf/keycloak.conf file, the https-key-store-password key will be set to the contents of the {file}/run/keys/store_password file.

Typeopen submodule of attribute set of (null or string or signed integer or boolean or attribute set of absolute path)

Example

{
  hostname = "localhost";
  https-key-store-file = "/path/to/file";
  https-key-store-password = { _secret = "/run/keys/store_password"; };
}

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.settings.hostname`

The hostname part of the public URL used as base for all frontend requests.

See https://www.keycloak.org/server/hostname for more information about hostname configuration.

Typestring

Default"localhost"

Example"localhost"

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.settings.http-host`

On which address Keycloak should accept new connections.

Typestring

Default"::"

Example"::1"

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.settings.http-port`

On which port Keycloak should listen for new HTTP connections.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default8080

Example8080

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.settings.http-relative-path`

The path relative to / for serving resources.

::: {.note} In versions of Keycloak using Wildfly (<17), this defaulted to /auth. If upgrading from the Wildfly version of Keycloak, i.e. a NixOS version before 22.05, you'll likely want to set this to /auth to keep compatibility with your clients.

See https://www.keycloak.org/migration/migrating-to-quarkus for more information on migrating from Wildfly to Quarkus. :::

Typestring

Default"/"

Example"/auth"

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.settings.https-port`

On which port Keycloak should listen for new HTTPS connections. If its not set, its disabled.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default34429

Example34429

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.sslCertificate`

The path to a PEM formatted certificate to use for TLS/SSL connections.

Typenull or relative path not in the Nix store

Defaultnull

Example"/run/keys/ssl_cert"

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.keycloak.sslCertificateKey`

The path to a PEM formatted private key to use for TLS/SSL connections.

Typenull or relative path not in the Nix store

Defaultnull

Example"/run/keys/ssl_key"

Declared indevenv/blob/main/src/modules/services/keycloak.nix

`services.mailhog.additionalArgs`

Additional arguments passed to mailhog.

Typelist of strings concatenated with "\n"

Default[ ]

Example

[
  "-invite-jim"
]

Declared indevenv/blob/main/src/modules/services/mailhog.nix

`services.mailhog.apiListenAddress`

Listen address for API.

Typestring

Default"127.0.0.1:8025"

Declared indevenv/blob/main/src/modules/services/mailhog.nix

`services.mailhog.enable`

Whether to enable mailhog process.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/mailhog.nix

`services.mailhog.package`

Which package of mailhog to use

Typepackage

Defaultpkgs.mailhog

Declared indevenv/blob/main/src/modules/services/mailhog.nix

`services.mailhog.smtpListenAddress`

Listen address for SMTP.

Typestring

Default"127.0.0.1:1025"

Declared indevenv/blob/main/src/modules/services/mailhog.nix

`services.mailhog.uiListenAddress`

Listen address for UI.

Typestring

Default"127.0.0.1:8025"

Declared indevenv/blob/main/src/modules/services/mailhog.nix

`services.mailpit.additionalArgs`

Additional arguments passed to mailpit.

Typelist of strings concatenated with "\n"

Default[ ]

Example

[
  "--max=500"
]

Declared indevenv/blob/main/src/modules/services/mailpit.nix

`services.mailpit.enable`

Whether to enable mailpit process.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/mailpit.nix

`services.mailpit.package`

Which package of mailpit to use

Typepackage

Defaultpkgs.mailpit

Declared indevenv/blob/main/src/modules/services/mailpit.nix

`services.mailpit.smtpListenAddress`

Listen address for SMTP.

Typestring

Default"127.0.0.1:1025"

Declared indevenv/blob/main/src/modules/services/mailpit.nix

`services.mailpit.uiListenAddress`

Listen address for UI.

Typestring

Default"127.0.0.1:8025"

Declared indevenv/blob/main/src/modules/services/mailpit.nix

`services.meilisearch.enable`

Whether to enable Meilisearch.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/meilisearch.nix

`services.meilisearch.environment`

Defines the running environment of Meilisearch.

Typeone of "development", "production"

Default"development"

Declared indevenv/blob/main/src/modules/services/meilisearch.nix

`services.meilisearch.listenAddress`

Meilisearch listen address.

Typestring

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/meilisearch.nix

`services.meilisearch.listenPort`

Meilisearch port to listen on.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default7700

Declared indevenv/blob/main/src/modules/services/meilisearch.nix

`services.meilisearch.logLevel`

Defines how much detail should be present in Meilisearch's logs. Meilisearch currently supports four log levels, listed in order of increasing verbosity:

'ERROR': only log unexpected events indicating Meilisearch is not functioning as expected
'WARN:' log all unexpected events, regardless of their severity
'INFO:' log all events. This is the default value
'DEBUG': log all events and including detailed information on Meilisearch's internal processes. Useful when diagnosing issues and debugging

Typestring

Default"INFO"

Declared indevenv/blob/main/src/modules/services/meilisearch.nix

`services.meilisearch.maxIndexSize`

Sets the maximum size of the index. Value must be given in bytes or explicitly stating a base unit. For example, the default value can be written as 107374182400, '107.7Gb', or '107374 Mb'. Default is 100 GiB

Typestring

Default"107374182400"

Declared indevenv/blob/main/src/modules/services/meilisearch.nix

`services.meilisearch.noAnalytics`

Deactivates analytics. Analytics allow Meilisearch to know how many users are using Meilisearch, which versions and which platforms are used. This process is entirely anonymous.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/meilisearch.nix

`services.meilisearch.package`

Which Meilisearch package to use

Typepackage

Default"pkgs.meilisearch"

Declared indevenv/blob/main/src/modules/services/meilisearch.nix

`services.memcached.bind`

The IP interface to bind to. null means "all interfaces".

Typenull or string

Default"127.0.0.1"

Example"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/memcached.nix

`services.memcached.enable`

Whether to enable memcached process.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/memcached.nix

`services.memcached.package`

Which package of memcached to use

Typepackage

Defaultpkgs.memcached

Declared indevenv/blob/main/src/modules/services/memcached.nix

`services.memcached.port`

The TCP port to accept connections. If port 0 is specified memcached will not listen on a TCP socket.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default11211

Declared indevenv/blob/main/src/modules/services/memcached.nix

`services.memcached.startArgs`

Additional arguments passed to memcached during startup.

Typelist of strings concatenated with "\n"

Default[ ]

Example

[
  "--memory-limit=100M"
]

Declared indevenv/blob/main/src/modules/services/memcached.nix

`services.minio.accessKey`

Access key of 5 to 20 characters in length that clients use to access the server.

Typestring

Default"minioadmin"

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.afterStart`

Bash code to execute after minio is running.

Typestrings concatenated with "\n"

Default""

Example

''
  mc anonymous set download local/mybucket
''

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.browser`

Enable or disable access to web UI.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.buckets`

List of buckets to ensure exist on startup.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.clientConfig`

Contents of the mc config.json, as a nix attribute set.

By default, local is configured to connect to the devenv minio service. Use lib.mkForce null to use your regular mc configuration from $HOME/.mc instead.

Typenull or JSON value

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.clientPackage`

MinIO client package to use.

Typepackage

Defaultpkgs.minio-client

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.consoleAddress`

IP address and port of the web UI (console).

Typestring

Default"127.0.0.1:9001"

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.enable`

Whether to enable MinIO Object Storage.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.listenAddress`

IP address and port of the server.

Typestring

Default"127.0.0.1:9000"

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.package`

MinIO package to use.

Typepackage

Defaultpkgs.minio

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.region`

The physical location of the server. By default it is set to us-east-1, which is same as AWS S3's and MinIO's default region.

Typestring

Default"us-east-1"

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.minio.secretKey`

Specify the Secret key of 8 to 40 characters in length that clients use to access the server.

Typestring

Default"minioadmin"

Declared indevenv/blob/main/src/modules/services/minio.nix

`services.mongodb.additionalArgs`

Additional arguments passed to mongod.

Typelist of strings concatenated with "\n"

Default

[
  "--noauth"
]

Example

[
  "--port"
  "27017"
  "--noauth"
]

Declared indevenv/blob/main/src/modules/services/mongodb.nix

`services.mongodb.enable`

Whether to enable MongoDB process and expose utilities.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/mongodb.nix

`services.mongodb.initDatabasePassword`

This used in conjunction with initDatabaseUsername, create a new user and set that user's password. This user is created in the admin authentication database and given the role of root, which is a "superuser" role.

Typestring

Default""

Example"secret"

Declared indevenv/blob/main/src/modules/services/mongodb.nix

`services.mongodb.initDatabaseUsername`

This used in conjunction with initDatabasePassword, create a new user and set that user's password. This user is created in the admin authentication database and given the role of root, which is a "superuser" role.

Typestring

Default""

Example"mongoadmin"

Declared indevenv/blob/main/src/modules/services/mongodb.nix

`services.mongodb.package`

Which MongoDB package to use.

Typepackage

Defaultpkgs.mongodb-ce

Declared indevenv/blob/main/src/modules/services/mongodb.nix

`services.mongodb.replication.enable`

Whether to enable MongoDB replication with a 1-node replica-set..

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/mongodb.nix

`services.mongodb.replication.replSet`

Replica-set name

Typestring

Default"rs0"

Example"rs0"

Declared indevenv/blob/main/src/modules/services/mongodb.nix

`services.mosquitto.bind`

The IP interface to bind to. null means "all interfaces".

Typenull or string

Default"127.0.0.1"

Example"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/mosquitto.nix

`services.mosquitto.enable`

Whether to enable mosquitto MQTT broker.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/mosquitto.nix

`services.mosquitto.extraConfig`

Additional text to append to mosquitto.conf.

Typestrings concatenated with "\n"

Default""

Example

''
  max_queued_messages 1000
''

Declared indevenv/blob/main/src/modules/services/mosquitto.nix

`services.mosquitto.package`

Which package of mosquitto to use

Typepackage

Defaultpkgs.mosquitto

Declared indevenv/blob/main/src/modules/services/mosquitto.nix

`services.mosquitto.port`

The TCP port to accept MQTT connections.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default1883

Declared indevenv/blob/main/src/modules/services/mosquitto.nix

`services.mysql.enable`

Whether to enable MySQL process and expose utilities.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.ensureUsers`

Ensures that the specified users exist and have at least the ensured permissions. The MySQL users will be identified using Unix socket authentication. This authenticates the Unix user with the same name only, and that without the need for a password. This option will never delete existing users or remove permissions, especially not when the value of this option is changed. This means that users created and permissions assigned once through this option or otherwise have to be removed manually.

Typelist of (submodule)

Default[ ]

Example

[
  {
    name = "devenv";
    ensurePermissions = {
      "devenv.*" = "ALL PRIVILEGES";
    };
  }
]

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.ensureUsers.*.ensurePermissions`

Permissions to ensure for the user, specified as attribute set. The attribute names specify the database and tables to grant the permissions for, separated by a dot. You may use wildcards here. The attribute values specfiy the permissions to grant. You may specify one or multiple comma-separated SQL privileges here. For more information on how to specify the target and on which privileges exist, see the GRANT syntax. The attributes are used as GRANT ${attrName} ON ${attrValue}.

Typeattribute set of string

Default{ }

Example

{
  "database.*" = "ALL PRIVILEGES";
  "*.*" = "SELECT, LOCK TABLES";
}

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.ensureUsers.*.host`

Host of the user to ensure.

Typestring

Default"localhost"

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.ensureUsers.*.name`

Name of the user to ensure.

Typestring

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.ensureUsers.*.password`

Password of the user to ensure.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.importTimeZones`

Whether to import tzdata on the first startup of the mysql server

Typenull or boolean

Defaultnull

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.initialDatabases`

List of database names and their initial schemas that should be used to create databases on the first startup of MySQL. The schema attribute is optional: If not specified, an empty database is created.

Typelist of (submodule)

Default[ ]

Example

[
  { name = "foodatabase"; schema = ./foodatabase.sql; }
  { name = "bardatabase"; }
]

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.initialDatabases.*.name`

The name of the database to create.

Typestring

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.initialDatabases.*.schema`

The initial schema of the database; if null (the default), an empty database is created.

Typenull or absolute path

Defaultnull

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.package`

Which package of MySQL to use

Typepackage

Defaultpkgs.mariadb

Declared indevenv/blob/main/src/modules/services/mysql.nix

`services.mysql.settings`

MySQL configuration.

Typelazy attribute set of lazy attribute set of anything

Default{ }

Example

{
  mysqld = {
    key_buffer_size = "6G";
    table_cache = 1600;
    log-error = "/var/log/mysql_err.log";
    plugin-load-add = [ "server_audit" "ed25519=auth_ed25519" ];
  };
  mysqldump = {
    quick = true;
    max_allowed_packet = "16M";
  };
}

Declared indevenv/blob/main/src/modules/services/mysql.nix

Typestring

Default""

Example"/var/log/nats-server.log"

Declared indevenv/blob/main/src/modules/services/nats.nix

`services.nats.monitoring.enable`

Enable HTTP monitoring endpoint. Provides /healthz, /varz, /connz, and other monitoring endpoints. Highly recommended for production deployments.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/nats.nix

`services.nats.monitoring.port`

Port for HTTP monitoring endpoint. Access monitoring at http://host:port/varz

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default8222

Declared indevenv/blob/main/src/modules/services/nats.nix

`services.nats.package`

Which NATS server package to use.

Typepackage

Defaultpkgs.nats-server

Declared indevenv/blob/main/src/modules/services/nats.nix

`services.nats.port`

Port to listen on for client connections.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default4222

Declared indevenv/blob/main/src/modules/services/nats.nix

`services.nats.serverName`

Server name for identification in clusters. If empty, NATS will auto-generate a unique name.

Typestring

Default""

Example"nats-dev-1"

Declared indevenv/blob/main/src/modules/services/nats.nix

`services.nats.settings`

Additional NATS server configuration as a Nix attribute set. This will be converted to NATS config file format.

Use this for advanced features like:

TLS/SSL configuration
Clustering with routes
MQTT gateway
WebSocket support
Custom authorization

See https://docs.nats.io/running-a-nats-service/configuration

Typeattribute set

Default{ }

Example

{
  tls = {
    cert_file = "/path/to/cert.pem";
    key_file = "/path/to/key.pem";
    verify = true;
  };
  cluster = {
    name = "my-cluster";
    listen = "0.0.0.0:6222";
    routes = [
      "nats://node1:6222"
      "nats://node2:6222"
    ];
  };
}

Declared indevenv/blob/main/src/modules/services/nats.nix

`services.nats.trace`

Enable protocol tracing for deep debugging. Warning: Very verbose output.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/nats.nix

`services.nginx.defaultMimeTypes`

Default MIME types for NGINX, as MIME types definitions from NGINX are very incomplete, we use by default the ones bundled in the mailcap package, used by most of the other Linux distributions.

Typeabsolute path

Default${pkgs.mailcap}/etc/nginx/mime.types

Example${pkgs.nginx}/conf/mime.types

Declared indevenv/blob/main/src/modules/services/nginx.nix

`services.nginx.enable`

Whether to enable nginx.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/nginx.nix

`services.nginx.eventsConfig`

The nginx events configuration.

Typestrings concatenated with "\n"

Default""

Declared indevenv/blob/main/src/modules/services/nginx.nix

`services.nginx.httpConfig`

The nginx configuration.

Typestrings concatenated with "\n"

Default""

Declared indevenv/blob/main/src/modules/services/nginx.nix

`services.nginx.package`

The nginx package to use.

Typepackage

Defaultpkgs.nginx

Declared indevenv/blob/main/src/modules/services/nginx.nix

`services.nixseparatedebuginfod.cache.directory`

Override the directory where files downloaded from the substituter are stored.

Default is $XDG_CACHE_DIR/nixseparatedebuginfod2.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/services/nixseparatedebuginfod.nix

`services.nixseparatedebuginfod.cache.expiration`

How long to keep cache entries. A number followed by a unit.

Typestring

Default"1d"

Declared indevenv/blob/main/src/modules/services/nixseparatedebuginfod.nix

`services.nixseparatedebuginfod.enable`

Whether to enable nixseparatedebuginfod.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/nixseparatedebuginfod.nix

`services.nixseparatedebuginfod.host`

IP address for nixseparatedebuginfod to listen on.

Typestring

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/nixseparatedebuginfod.nix

`services.nixseparatedebuginfod.package`

nixseparatedebuginfod package to use.

Typepackage

Defaultpkgs.nixseparatedebuginfod2

Declared indevenv/blob/main/src/modules/services/nixseparatedebuginfod.nix

`services.nixseparatedebuginfod.port`

Port for nixseparatedebuginfod to listen on.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default1949

Declared indevenv/blob/main/src/modules/services/nixseparatedebuginfod.nix

`services.nixseparatedebuginfod.substituters`

Substituters to fetch debuginfo from.

Typelist of string

Default

[
  "local:"
  "https://cache.nixos.org"
]

Declared indevenv/blob/main/src/modules/services/nixseparatedebuginfod.nix

`services.opensearch.enable`

Whether to enable OpenSearch.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.extraCmdLineOptions`

Extra command line options for the OpenSearch launcher.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.extraJavaOptions`

Extra command line options for Java.

Typelist of string

Default[ ]

Example

[
  "-Djava.net.preferIPv4Stack=true"
]

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.logging`

OpenSearch logging configuration.

Typestring

Default

''
  logger.action.name = org.opensearch.action
  logger.action.level = info
  appender.console.type = Console
  appender.console.name = console
  appender.console.layout.type = PatternLayout
  appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n
  rootLogger.level = info
  rootLogger.appenderRef.console.ref = console
''

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.package`

The OpenSearch package to use.

Typepackage

Defaultpkgs.opensearch

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.settings`

OpenSearch configuration.

Typeopen submodule of (YAML 1.1 value)

Default{ }

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.settings."cluster.name"`

The name of the cluster.

Typestring

Default"opensearch"

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.settings."discovery.type"`

The type of discovery to use.

Typestring

Default"single-node"

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.settings."http.port"`

The port to listen on for HTTP traffic.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default9200

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.settings."network.host"`

Which port this service should listen on.

Typestring

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.settings."plugins.security.disabled"`

Whether to disable the security plugin. When set to false, SSL configuration is required. To enable SSL, set plugins.security.ssl.transport.keystore_filepath or both plugins.security.ssl.transport.server.pemcert_filepath and plugins.security.ssl.transport.client.pemcert_filepath.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opensearch.settings."transport.port"`

The port to listen on for transport traffic.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default9300

Declared indevenv/blob/main/src/modules/services/opensearch.nix

`services.opentelemetry-collector.configFile`

Override the configuration file used by OpenTelemetry Collector. By default, a configuration is generated from services.opentelemetry-collector.settings.

If overriding, enable the health_check extension to allow the readiness probe to check whether the Collector is ready. Otherwise, disable the readiness probe by setting processes.opentelemetry-collector.ready = lib.mkForce null;.

Typenull or absolute path

Defaultnull

Example

pkgs.writeTextFile { name = "otel-config.yaml"; text = "..."; }

Declared indevenv/blob/main/src/modules/services/opentelemetry-collector.nix

`services.opentelemetry-collector.enable`

Whether to enable opentelemetry-collector.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/opentelemetry-collector.nix

`services.opentelemetry-collector.package`

The OpenTelemetry Collector package to use

Typepackage

Defaultpkgs.opentelemetry-collector-contrib

Declared indevenv/blob/main/src/modules/services/opentelemetry-collector.nix

`services.opentelemetry-collector.settings`

OpenTelemetry Collector configuration. Refer to https://opentelemetry.io/docs/collector/configuration/ for more information on how to configure the Collector.

Typeopen submodule of (YAML 1.1 value)

DefaultdefaultSettings

Declared indevenv/blob/main/src/modules/services/opentelemetry-collector.nix

`services.postgres.createDatabase`

Create a database named like current user on startup. Only applies when initialDatabases is an empty list.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.enable`

Whether to enable Add PostgreSQL process. .

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.extensions`

Additional PostgreSQL extensions to install.

The available extensions are:

age
anonymizer
apache_datasketches
callPackage
citus
cstore_fdw
h3-pg
hypopg
ip4r
jsonb_deep_sum
lantern
omnigres
periods
pg-gvm
pg-semver
pg_auto_failover
pg_background
pg_bigm
pg_byteamagic
pg_cron
pg_csv
pg_ed25519
pg_embedding
pg_graphql
pg_hint_plan
pg_hll
pg_ivm
pg_libversion
pg_net
pg_partman
pg_rational
pg_relusage
pg_repack
pg_roaringbitmap
pg_safeupdate
pg_search
pg_similarity
pg_squeeze
pg_tle
pg_topn
pg_uuidv7
pgaudit
pgddl
pgjwt
pgmq
pgroonga
pgrouting
pgsodium
pgsql-http
pgtap
pgvecto-rs
pgvector
pgvectorscale
pgx_ulid
plperl
plpgsql_check
plpython3
plr
pltcl
plv8
pointcloud
postgis
repmgr
rum
smlar
sqlite_fdw
system_stats
tds_fdw
temporal_tables
timescaledb
timescaledb-apache
timescaledb_toolkit
tsja
vectorchord
wal2json

Typenull or (function that evaluates to a(n) list of package)

Defaultnull

Example

extensions: [
  extensions.pg_cron
  extensions.postgis
  extensions.timescaledb
];

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.hbaConf`

The contents of a custom pg_hba.conf file to copy into the postgres installation. This allows for custom connection rules that you want to establish on the server.

Typenull or string

Defaultnull

Example

builtins.readFile ./my-custom/directory/to/pg_hba.conf

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.initdbArgs`

Additional arguments passed to initdb during data dir initialisation.

Typelist of strings concatenated with "\n"

Default

[
  "--locale=C"
  "--encoding=UTF8"
]

Example

[
  "--data-checksums"
  "--allow-group-access"
]

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.initialDatabases`

List of database names and their initial schemas that should be used to create databases on the first startup of Postgres. The schema attribute is optional: If not specified, an empty database is created.

Typelist of (submodule)

Default[ ]

Example

[
  {
    name = "foodatabase";
    schema = ./foodatabase.sql;
  }
  { name = "bardatabase"; }
]

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.initialDatabases.*.initialSQL`

SQL commands to run on this specific database during it's initialization. Multiple SQL expressions can be separated by semicolons.

Typenull or string

Defaultnull

Example

CREATE TABLE users (id SERIAL PRIMARY KEY, name TEXT);
INSERT INTO users (name) VALUES ('admin');
CREATE EXTENSION IF NOT EXISTS pg_uuidv7;

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.initialDatabases.*.name`

The name of the database to create.

Typestring

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.initialDatabases.*.pass`

Password of the database owner role. Requires user to be set.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.initialDatabases.*.schema`

The initial schema of the database; if null (the default), an empty database is created.

Typenull or absolute path

Defaultnull

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.initialDatabases.*.user`

Username of owner of the database. If set, a role with this name is created and the database is owned by it. If null, the default $USER is used.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.initialScript`

Initial SQL commands to run during database initialization. This can be multiple SQL expressions separated by a semi-colon. Use initialScript for server-wide setup, such as creating roles or configuring global settings. For database-specific initialization, use initialSQL within initialDatabases. initialScript is executed after the initialDatabases setup is done.

Typenull or string

Defaultnull

Example

CREATE ROLE postgres SUPERUSER;
CREATE ROLE bar;

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.listen_addresses`

A comma-separated list of TCP/IP address(es) on which the server should listen for connections.

By default, the server only accepts connections over unix sockets.

This option is parsed to set the PGHOST environment variable.

Special values:

'*' to listen on all available network interfaces.
'0.0.0.0' to listen on all available IPv4 network interfaces.
'::' to listen on all available IPv6 network interfaces.
'localhost' to listen only on the loopback interface.
'' (empty string) disables TCP/IP connections and listens only on the unix socket.

Typestring

Default""

Example"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.package`

The PostgreSQL package to use. Use this to override the default with a specific version.

Typepackage

Defaultpkgs.postgresql

Example

pkgs.postgresql_15

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.port`

The TCP port to accept connections.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default5432

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.postgres.settings`

PostgreSQL configuration. Refer to https://www.postgresql.org/docs/11/config-setting.html#CONFIG-SETTING-CONFIGURATION-FILE for an overview of postgresql.conf.

String values will automatically be enclosed in single quotes. Single quotes will be escaped with two single quotes as described by the upstream documentation linked above.

Typeattribute set of (boolean or floating point number or signed integer or string)

Default{ }

Example

{
  log_connections = true;
  log_statement = "all";
  logging_collector = true
  log_disconnections = true
  log_destination = lib.mkForce "syslog";
}

Declared indevenv/blob/main/src/modules/services/postgres.nix

`services.prometheus.advanced.storage`

Storage configuration

Typeattribute set

Default{ }

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.prometheus.advanced.tsdb`

TSDB configuration

Typeattribute set

Default{ }

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.prometheus.alerting`

Alerting configuration

Typenull or (attribute set)

Defaultnull

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.prometheus.enable`

Whether to enable Prometheus monitoring system.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.prometheus.experimentalFeatures.enableExemplars`

Enable exemplar storage

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.prometheus.experimentalFeatures.enableOTLP`

Enable OTLP receiver

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.prometheus.experimentalFeatures.enableTracing`

Enable tracing

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.prometheus.extraArgs`

Additional arguments to pass to Prometheus

Typestring

Default""

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.prometheus.globalConfig`

Global Prometheus configuration

Typeattribute set

Default

{
  evaluation_interval = "1m";
  scrape_interval = "1m";
  scrape_timeout = "10s";
}

Declared indevenv/blob/main/src/modules/services/prometheus.nix

`services.rabbitmq.configItems`

Configuration options in RabbitMQ's new config file format, which is a simple key-value format that can not express nested data structures. This is known as the rabbitmq.conf file, although outside NixOS that filename may have Erlang syntax, particularly prior to RabbitMQ 3.7.0. If you do need to express nested data structures, you can use config option. Configuration from config will be merged into these options by RabbitMQ at runtime to form the final configuration. See https://www.rabbitmq.com/configure.html#config-items For the distinct formats, see https://www.rabbitmq.com/configure.html#config-file-formats

Typeattribute set of string

Default{ }

Example

{
  "auth_backends.1.authn" = "rabbit_auth_backend_ldap";
  "auth_backends.1.authz" = "rabbit_auth_backend_internal";
}

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.cookie`

Erlang cookie is a string of arbitrary length which must be the same for several nodes to be allowed to communicate. Leave empty to generate automatically.

Typestring

Default""

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.enable`

Whether to enable the RabbitMQ server, an Advanced Message Queuing Protocol (AMQP) broker.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.listenAddress`

IP address on which RabbitMQ will listen for AMQP connections. Set to the empty string to listen on all interfaces. Note that RabbitMQ creates a user named guest with password guest by default, so you should delete this user if you intend to allow external access. Together with 'port' setting it's mostly an alias for configItems."listeners.tcp.1" and it's left for backwards compatibility with previous version of this module.

Typestring

Default"127.0.0.1"

Example""

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.managementPlugin.enable`

Whether to enable the management plugin.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.managementPlugin.port`

On which port to run the management plugin.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default15672

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.nodeName`

The name of the RabbitMQ node. This is used to identify the node in a cluster. If you are running multiple RabbitMQ nodes on the same machine, you must give each node a unique name. The name must be of the form name@host, where name is an arbitrary name and host is the domain name of the host.

Typestring

Default"rabbit@localhost"

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.package`

Which rabbitmq package to use.

Typepackage

Defaultpkgs.rabbitmq-server

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.pluginDirs`

The list of directories containing external plugins

Typelist of absolute path

Default[ ]

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.plugins`

The names of plugins to enable

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.rabbitmq.port`

Port on which RabbitMQ will listen for AMQP connections.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default5672

Declared indevenv/blob/main/src/modules/services/rabbitmq.nix

`services.redis.bind`

The IP interface to bind to. null means "all interfaces".

Typenull or string

Default"127.0.0.1"

Example"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/redis.nix

`services.redis.enable`

Whether to enable Redis process and expose utilities.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/redis.nix

`services.redis.extraConfig`

Additional text to be appended to redis.conf.

Typestrings concatenated with "\n"

Default"locale-collate C"

Declared indevenv/blob/main/src/modules/services/redis.nix

`services.redis.package`

Which package of Redis to use

Typepackage

Defaultpkgs.redis

Declared indevenv/blob/main/src/modules/services/redis.nix

`services.redis.port`

The TCP port to accept connections. If port 0 is specified, Redis will not listen on a TCP socket and a unix socket file will be found at $REDIS_UNIX_SOCKET.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default6379

Declared indevenv/blob/main/src/modules/services/redis.nix

`services.rustfs.accessKey`

Access key for authentication (5 to 20 characters).

Typestring

Default"rustfsadmin"

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.rustfs.bind`

The IP interface to bind to. null means "all interfaces".

Typenull or string

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.rustfs.consoleEnable`

Enable or disable the web console.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.rustfs.consolePort`

The TCP port for the web console.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default9001

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.rustfs.enable`

Whether to enable RustFS object storage.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.rustfs.extraEnvironment`

Additional environment variables to pass to RustFS. See the RustFS documentation for available options (e.g. RUSTFS_CORS_ALLOWED_ORIGINS, RUSTFS_TLS_PATH).

Typeattribute set of string

Default{ }

Example

{
  RUSTFS_OBJECT_CACHE_ENABLE = "true";
  RUSTFS_OBS_LOGGER_LEVEL = "debug";
}

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.rustfs.package`

Which package of RustFS to use

Typepackage

DefaultrustfsInput.packages.${pkgs.stdenv.system}.default

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.rustfs.port`

The TCP port for the S3 API.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default9000

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.rustfs.secretKey`

Secret key for authentication (8 to 40 characters).

Typestring

Default"rustfsadmin"

Declared indevenv/blob/main/src/modules/services/rustfs.nix

`services.sqld.enable`

Whether to enable sqld.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/sqld.nix

`services.sqld.extraArgs`

Add other sqld flags.

Typelist of string

Default[ ]

Declared indevenv/blob/main/src/modules/services/sqld.nix

`services.sqld.port`

Port number to listen on.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default8080

Declared indevenv/blob/main/src/modules/services/sqld.nix

`services.tailscale.funnel.enable`

Whether to enable Tailscale funnel.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/tailscale.nix

`services.tailscale.funnel.target`

Target host or host:port for Tailscale funnel

Typestring

Declared indevenv/blob/main/src/modules/services/tailscale.nix

`services.temporal.dynamicConfig`

Dynamic configuration for the Temporal server.

Typeattribute set of string

Default{ }

Example

{
  "frontend.namespacerps" = "2500";
  "frontend.rps" = "2500";
}

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.enable`

Whether to enable Temporal process.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.ip`

IPv4 address to bind the frontend service to.

Typestring

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.namespaces`

Specify namespaces that should be pre-created (namespace "default" is always created).

Typelist of string

Default[ ]

Example

[
  "my-namespace"
  "my-other-namespace"
]

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.package`

Which package of Temporal to use.

Typepackage

Defaultpkgs.temporal-cli

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.port`

Port for the frontend gRPC service.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default7233

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.state`

State configuration.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.state.ephemeral`

When enabled, the Temporal state gets lost when the process exists.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.state.sqlite-pragma`

Sqlite pragma statements

Typeattribute set of string

Default{ }

Example

{
  journal_mode = "wal";
  synchronous = "2";
}

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.ui`

UI configuration.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.ui.enable`

Enable the Web UI.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.ui.ip`

IPv4 address to bind the Web UI to.

Typestring

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.temporal.ui.port`

Port for the Web UI.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default8233

Declared indevenv/blob/main/src/modules/services/temporal.nix

`services.tideways.apiKey`

Sets the API-Key for the Tideways Daemon.

Typestring

Default""

Declared indevenv/blob/main/src/modules/services/tideways.nix

`services.tideways.cliPackage`

Which package of tideways-cli to use

Typepackage

Defaultpkgs.tideways-cli

Declared indevenv/blob/main/src/modules/services/tideways.nix

`services.tideways.daemonPackage`

Which package of tideways-daemon to use

Typepackage

Defaultpkgs.tideways-daemon

Declared indevenv/blob/main/src/modules/services/tideways.nix

`services.tideways.enable`

Whether to enable Tideways profiler daemon

It automatically installs Tideways PHP extension. .

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/tideways.nix

`services.tideways.environment`

Sets the Environment for Tideways Daemon.

Typestring

Default"devenv"

Declared indevenv/blob/main/src/modules/services/tideways.nix

`services.tideways.profilingSpace`

When the profiling space is enabled, the default monitoring will be disabled.

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/tideways.nix

`services.tideways.service`

Sets the Service name for Tideways Daemon.

Typestring

Default""

Declared indevenv/blob/main/src/modules/services/tideways.nix

`services.trafficserver.cache`

Caching rules that overrule the origin's caching policy.

Consult the upstream documentation for more details.

Typestrings concatenated with "\n"

Default""

Example"dest_domain=example.com suffix=js action=never-cache"

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.enable`

Whether to enable Apache Traffic Server.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.hosting`

Partition the cache according to origin server or domain

Consult the upstream documentation for more details.

Typestrings concatenated with "\n"

Default""

Example"domain=example.com volume=1"

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.ipAllow`

Control client access to Traffic Server and Traffic Server connections to upstream servers.

Consult the upstream documentation for more details.

Typenull or YAML 1.1 value

Defaultupstream defaults

Example

{
  ip_allow = [{
    apply = "in";
    ip_addrs = "127.0.0.1";
    action = "allow";
    methods = "ALL";
  }];
}

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.logging`

Configure logs.

Consult the upstream documentation for more details.

Typenull or YAML 1.1 value

Defaultupstream defaults

Example{ }

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.package`

Apache Traffic Server package

Typepackage

Defaultpkgs.trafficserver

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.parent`

Identify the parent proxies used in an cache hierarchy.

Consult the upstream documentation for more details.

Typestrings concatenated with "\n"

Default""

Example

''
  dest_domain=. method=get parent="p1.example:8080; p2.example:8080" round_robin=true
''

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.plugins`

Controls run-time loadable plugins available to Traffic Server, as well as their configuration.

Consult the upstream documentation for more details.

Typelist of (submodule)

Default[ ]

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.plugins.*.arg`

arguments to pass to the plugin

Typestring

Default""

Example"--header=ATS-My-Debug"

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.plugins.*.path`

Path to plugin. The path can either be absolute, or relative to the plugin directory.

Typestring

Example"xdebug.so"

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.records`

List of configurable variables used by Traffic Server.

Consult the upstream documentation for more details.

When defining the values for the option x.y, a nested attribute should be used. Using a flat attribute set with the attribute name x.y will result in an error.

If options for both x.y and x.y.z needs to be set, you can set x.y._ as x.y. This only applies to Traffic Server versions prior to 10. Traffic Server 10 and onwards uses YAML configuration, which doesn't have this kind of problem.

TypeTraffic Server records value

Default{ }

Example

{
  proxy = {
    config = {
      proxy_name = "my_server";
    };
  };
}

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.remap`

URL remapping rules used by Traffic Server.

Consult the upstream documentation for more details.

Typestrings concatenated with "\n"

Default""

Example"map http://from.example http://origin.example"

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.runroot`

File layout used by Traffic Server

Typeunspecified value

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.sni`

Configure aspects of TLS connection handling for both inbound and outbound connections.

Consult the upstream documentation for more details.

Typenull or YAML 1.1 value

Defaultnull

Example

{
  sni = [{
    fqdn = "no-http2.example.com";
    https = "off";
  }];
}

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.splitDns`

Specify the DNS server that Traffic Server should use under specific conditions.

Consult the upstream documentation for more details.

Typestrings concatenated with "\n"

Default""

Example

''
  dest_domain=internal.corp.example named="255.255.255.255:212 255.255.255.254" def_domain=corp.example search_list="corp.example corp1.example"
  dest_domain=!internal.corp.example named=255.255.255.253
''

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.sslMulticert`

Configure SSL server certificates to terminate the SSL sessions.

Consult the upstream documentation for more details.

Typestrings concatenated with "\n"

Default""

Example"dest_ip=* ssl_cert_name=default.pem"

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.storage`

List all the storage that make up the Traffic Server cache.

Consult the upstream documentation for more details.

Typestrings concatenated with "\n"

Default"${config.services.traffic-server.runroot.cachedir} 256M"

Example"/dev/disk/by-id/XXXXX volume=1"

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.strategies`

Specify the next hop proxies used in an cache hierarchy and the algorithms used to select the next proxy.

Consult the upstream documentation for more details.

Typenull or YAML 1.1 value

Defaultnull

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.trafficserver.volume`

Manage cache space more efficiently and restrict disk usage by creating cache volumes of different sizes.

Consult the upstream documentation for more details.

Typenull or YAML 1.1 value

Default""

Example"volume=1 scheme=http size=20%"

Declared indevenv/blob/main/src/modules/services/trafficserver

`services.typesense.additionalArgs`

Additional arguments passed to typesense.

Typelist of strings concatenated with "\n"

Default[ ]

Example[ ]

Declared indevenv/blob/main/src/modules/services/typesense.nix

`services.typesense.apiKey`

API Key.

Typestring

Default"example"

Declared indevenv/blob/main/src/modules/services/typesense.nix

`services.typesense.enable`

Whether to enable typesense process.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/typesense.nix

`services.typesense.host`

The HTTP host to accept connections.

Typestring

Default"127.0.0.1"

Declared indevenv/blob/main/src/modules/services/typesense.nix

`services.typesense.package`

Which package of typesense to use

Typepackage

Defaultpkgs.typesense

Declared indevenv/blob/main/src/modules/services/typesense.nix

`services.typesense.port`

The HTTP port to accept connections.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default8108

Declared indevenv/blob/main/src/modules/services/typesense.nix

`services.typesense.searchOnlyKey`

Search Only Key.

Typenull or string

Defaultnull

Declared indevenv/blob/main/src/modules/services/typesense.nix

`services.varnish.enable`

Whether to enable Varnish process and expose utilities.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/varnish.nix

`services.varnish.extraModules`

Varnish modules (except 'std').

Typelist of package

Default[ ]

Example[ pkgs.varnish73Packages.modules ]

Declared indevenv/blob/main/src/modules/services/varnish.nix

`services.varnish.listen`

Which address to listen on.

Typestring

Default"127.0.0.1:6081"

Declared indevenv/blob/main/src/modules/services/varnish.nix

`services.varnish.memorySize`

How much memory to allocate to Varnish.

Typestring

Default"64M"

Declared indevenv/blob/main/src/modules/services/varnish.nix

`services.varnish.package`

Which Varnish package to use.

Typepackage

Defaultpkgs.varnish

Declared indevenv/blob/main/src/modules/services/varnish.nix

`services.varnish.vcl`

Varnish VCL configuration.

Typestrings concatenated with "\n"

Default

''
  vcl 4.0;
  
  backend default {
    .host = "127.0.0.1";
    .port = "80";
  }
''

Declared indevenv/blob/main/src/modules/services/varnish.nix

`services.vault.address`

Specifies the address to bind to for listening

Typestring

Default"127.0.0.1:8200"

Declared indevenv/blob/main/src/modules/services/vault.nix

`services.vault.disableClustering`

Specifies whether clustering features such as request forwarding are enabled

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/vault.nix

`services.vault.disableMlock`

Disables the server from executing the mlock syscall

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/vault.nix

`services.vault.enable`

Whether to enable vault process.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/vault.nix

`services.vault.package`

Which package of Vault to use.

Typepackage

Defaultpkgs.vault-bin

Declared indevenv/blob/main/src/modules/services/vault.nix

`services.vault.ui`

Enables the built-in web UI

Typeboolean

Defaulttrue

Declared indevenv/blob/main/src/modules/services/vault.nix

`services.wiremock.disableBanner`

Whether to disable print banner logo.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/wiremock.nix

`services.wiremock.enable`

Whether to enable WireMock.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/services/wiremock.nix

`services.wiremock.mappings`

The mappings to mock. See the JSON examples on https://wiremock.org/docs/stubbing/ for more information.

TypeJSON value

Default[ ]

Example

[
  {
    request = {
      method = "GET";
      url = "/body";
    };
    response = {
      body = "Literal text to put in the body";
      headers = {
        Content-Type = "text/plain";
      };
      status = 200;
    };
  }
  {
    request = {
      method = "GET";
      url = "/json";
    };
    response = {
      jsonBody = {
        someField = "someValue";
      };
      status = 200;
    };
  }
]

Declared indevenv/blob/main/src/modules/services/wiremock.nix

`services.wiremock.package`

Which package of WireMock to use.

Typepackage

Defaultpkgs.wiremock

Declared indevenv/blob/main/src/modules/services/wiremock.nix

`services.wiremock.port`

The port number for the HTTP server to listen on.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default8080

Declared indevenv/blob/main/src/modules/services/wiremock.nix

`services.wiremock.rootDir`

Path to the WireMock root directory containing mappings and files. Cannot be set together with mappings. See https://wiremock.org/docs/standalone/java-jar/#command-line-options for more information.

Typenull or absolute path

Defaultnull

Declared indevenv/blob/main/src/modules/services/wiremock.nix

`services.wiremock.verbose`

Whether to log verbosely to stdout.

Typeboolean

Defaultfalse

Declared indevenv/blob/main/src/modules/services/wiremock.nix

starship

`starship.config.enable`

Whether to enable Starship config override.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/integrations/starship.nix

`starship.config.path`

The Starship configuration file to use.

Typenull or absolute path

Defaultnull

Example${config.env.DEVENV_ROOT}/starship.toml

Declared indevenv/blob/main/src/modules/integrations/starship.nix

`starship.config.settings`

Starship configuration to use

TypeTOML value

Default{}

Declared indevenv/blob/main/src/modules/integrations/starship.nix

`starship.enable`

Whether to enable the Starship.rs command prompt.

Typeboolean

Defaultfalse

Exampletrue

Declared indevenv/blob/main/src/modules/integrations/starship.nix

`starship.package`

The Starship package to use.

Typepackage

Defaultpkgs.starship

Declared indevenv/blob/main/src/modules/integrations/starship.nix

stdenv

`stdenv`

The stdenv to use for the developer environment.

Typepackage

Defaultpkgs.stdenv

Declared indevenv/blob/main/src/modules/top-level.nix

tasks

`tasks`

A set of tasks.

Typeattribute set of (submodule)

`tasks.<name>.after`

List of tasks that must complete before this task runs.

Here's a helpful mnemonic to remember: This task runs after these tasks.

You can append a suffix to control dependency behavior:

task@started - wait for task to begin execution
task or task@ready - wait for task to be ready/healthy (default for processes, processes only)
task@succeeded - wait for task to exit successfully (default for tasks, tasks only)
task@completed - wait for task to finish, regardless of exit code (soft dependency)

Example: after = [ "pnpm:install@completed" ]; allows this task to run even if pnpm:install fails.

Typelist of string

Default[ ]

`tasks.<name>.before`

List of tasks that depend on this task completing first.

Here's a helpful mnemonic to remember: This task runs before these tasks.

You can append a suffix to control dependency behavior:

task@started - the dependent waits for this task to begin execution
task or task@ready - the dependent waits for this task to be ready/healthy (default for processes, processes only)
task@succeeded - the dependent waits for this task to exit successfully (default for tasks, tasks only)
task@completed - the dependent waits for this task to finish (soft dependency)

Typelist of string

Default[ ]

`tasks.<name>.binary`

Override the binary name from the default package.meta.mainProgram.

Typenull or string

Defaultnull

`tasks.<name>.cwd`

Working directory to run the task in. If not specified, the current working directory will be used.

Typenull or string

Defaultnull

`tasks.<name>.description`

Description of the task.

Typestring

Default""

`tasks.<name>.env`

Environment variables to set for this task.

Typeattribute set of string

Default{ }

`tasks.<name>.exec`

Command to execute the task.

Typenull or string

Defaultnull

`tasks.<name>.execIfModified`

Paths to files that should trigger a task execution if modified.

Typelist of string

Default[ ]

`tasks.<name>.exports`

List of environment variables to export.

Typelist of string

Default[ ]

`tasks.<name>.input`

Input values for the task, encoded as JSON.

Typeattribute set of anything

Default{ }

`tasks.<name>.package`

Package to install for this task.

Typepackage

Defaultpkgs.bash

`tasks.<name>.process`

Process-specific configuration. Only used when type = "process".

Typesubmodule

Default{ }

`tasks.<name>.process.linux`

Linux-specific process configuration.

Requires devenv 2.0+.

Typesubmodule

Default{ }

`tasks.<name>.process.linux.capabilities`

Linux capabilities to add as ambient capabilities for this process (e.g., "net_bind_service", "net_admin").

Requires devenv 2.0+.

Typelist of string

Default[ ]

Example

[
  "net_bind_service"
  "net_admin"
]

`tasks.<name>.process.listen`

Socket activation configuration for systemd-style socket passing.

Typelist of (submodule)

Default[ ]

Example

[
  {
    address = "127.0.0.1:8080";
    kind = "tcp";
    name = "http";
  }
  {
    kind = "unix_stream";
    mode = 384;
    name = "admin";
    path = "$DEVENV_STATE/admin.sock";
  }
]

`tasks.<name>.process.listen.*.address`

TCP address (e.g., '127.0.0.1:8080'). Required for TCP sockets.

Allocated ports for this process (name -> port number). Populated automatically from process port allocation.

Typeattribute set of 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default{ }

`tasks.<name>.process.proxy.hostname`

Full .localhost proxy hostname for this process.

Typenull or string

Defaultnull

`tasks.<name>.process.proxy.https.enable`

Whether to enable HTTPS proxy URLs for this process.

Typeboolean

Defaultfalse

Exampletrue

`tasks.<name>.process.proxy.port_hostnames`

Full .localhost proxy hostnames keyed by port name.

Typeattribute set of string

Default{ }

`tasks.<name>.process.ready`

How to determine if this process task is ready to serve.

Typenull or (submodule)

Defaultnull

`tasks.<name>.process.ready.exec`

Shell command to execute. Exit 0 = ready.

Typenull or string

Defaultnull

Example"pg_isready -d template1"

`tasks.<name>.process.ready.failure_threshold`

Consecutive failures before marking unhealthy.

Typesigned integer

Default3

`tasks.<name>.process.ready.http`

HTTP readiness probe configuration.

Typesubmodule

Default{ }

`tasks.<name>.process.ready.http.get`

HTTP GET readiness check.

Typenull or (submodule)

Defaultnull

`tasks.<name>.process.ready.http.get.host`

Host to connect to.

Typestring

Default"127.0.0.1"

`tasks.<name>.process.ready.http.get.path`

HTTP path to request.

Typestring

Default"/"

`tasks.<name>.process.ready.http.get.port`

Port to connect to.

Type16 bit unsigned integer; between 0 and 65535 (both inclusive)

`tasks.<name>.process.ready.http.get.scheme`

URL scheme (http or https).

Typestring

Default"http"

`tasks.<name>.process.ready.initial_delay`

Seconds to wait before first probe.

Typesigned integer

Default0

`tasks.<name>.process.ready.notify`

Enable systemd notify protocol for readiness signaling. The process must send READY=1 to the NOTIFY_SOCKET.

Typeboolean

Defaultfalse

`tasks.<name>.process.ready.period`

Seconds between probes.

Typesigned integer

Default10

`tasks.<name>.process.ready.probe_timeout`

Seconds before a single probe times out.

Typesigned integer

Default1

`tasks.<name>.process.ready.success_threshold`

Consecutive successes needed to be considered ready.

Typesigned integer

Default1

`tasks.<name>.process.ready.timeout`

Overall deadline in seconds for the process to become ready. null = no deadline.

Typenull or (unsigned integer, meaning >=0)

Defaultnull

`tasks.<name>.process.restart`

Process restart policy.

Typesubmodule

Default{ }

`tasks.<name>.process.restart.max`

Maximum restart attempts. null = unlimited.

Typenull or signed integer

Default5

`tasks.<name>.process.restart.on`

When to restart: never, always, or on_failure.

Typeone of "never", "always", "on_failure"

Default"on_failure"

`tasks.<name>.process.restart.window`

Sliding window in seconds for restart rate limiting. null = lifetime limit.

Typenull or (unsigned integer, meaning >=0)

Defaultnull

`tasks.<name>.process.shutdown`

Graceful shutdown signal and timeout.

Typesubmodule

Default{ }

`tasks.<name>.process.shutdown.grace`

Seconds before shutdown escalates to SIGKILL.

Typeunsigned integer, meaning >=0

Default5

`tasks.<name>.process.shutdown.signal`

Unix signal number used for graceful shutdown.

Typeinteger between 1 and 31 (both inclusive)

Default15

`tasks.<name>.process.start`

Auto-start configuration for this process.

Typesubmodule

Default{ }

`tasks.<name>.process.start.enable`

Whether to start this process automatically with devenv up.

`tasks.<name>.process.watchdog.require_ready`

Require READY=1 notification before enforcing watchdog

Typeboolean

Defaulttrue

`tasks.<name>.process.watchdog.usec`

Watchdog interval in microseconds

Typesigned integer

`tasks.<name>.showOutput`

Always show task output (stdout and stderr), regardless of whether the task succeeds or fails.

Typeboolean

Defaultfalse

`tasks.<name>.status`

Check if the command should be ran

Typenull or string

Defaultnull

`tasks.<name>.type`

Type of task:

oneshot: Task runs once and completes (default)
process: Task is a long-running process

Typeone of "oneshot", "process"

Default"oneshot"

treefmt

`treefmt.config`

treefmt configuration.

Typesubmodule

Default{ }

Declared indevenv/blob/main/src/modules/integrations/treefmt.nix

`treefmt.config.build.check`

Create a flake check to test that the given project tree is already formatted.

Input argument is the path to the project tree (usually 'self').

Typefunction that evaluates to a(n) package

DefaultDefault check implementation

Declared intreefmt-nix/blob/main/module-options.nix

`treefmt.config.build.configFile`

Contains the generated config file derived from the settings.

Typeabsolute path

Declared intreefmt-nix/blob/main/module-options.nix

`treefmt.config.build.devShell`

The development shell with treefmt and its underlying programs

Typepackage

Declared intreefmt-nix/blob/main/module-options.nix

`treefmt.config.build.programs`

Attrset of formatter programs enabled in treefmt configuration.

The key of the attrset is the formatter name, with the value being the package used to do the formatting.

Typeattribute set of package

DefaultPrograms used in configuration

Declared intreefmt-nix/blob/main/module-options.nix

`treefmt.config.build.wrapper`

The treefmt package, wrapped with the config file.

Typepackage

Defaultwrapped `treefmt` command

Declared intreefmt-nix/blob/main/module-options.nix

`treefmt.config.enableDefaultExcludes`

Enable the default excludes in the treefmt configuration.

Typeboolean

Defaulttrue

Declared intreefmt-nix/blob/main/module-options.nix

`treefmt.config.package`

The treefmt package to use.

Typepackage

Defaultpkgs.treefmt

Enable or disable in a specific context.

Typenull or (submodule)

Defaultnull

Declared intreefmt-nix/blob/main/programs/autocorrect.nix

`treefmt.config.programs.autocorrect.settings.context.codeblock`

Enable or disable to format codeblock in Markdown or AsciiDoc etc.

Typenull or one of "off", "error", "warning"

Defaultnull

Example"error"

Declared intreefmt-nix/blob/main/programs/autocorrect.nix

`treefmt.config.programs.autocorrect.settings.fileTypes`

Configure the files associations, you config is higher priority than default.

Typenull or (attribute set of string)

Defaultnull

Example

{
  "*.js" = "javascript";
  ".mdx" = "markdown";
  Rakefile = "ruby";
  rb = "ruby";
}

Declared intreefmt-nix/blob/main/programs/autocorrect.nix

Spellcheck configuration.

Typenull or (submodule)

Defaultnull

Declared intreefmt-nix/blob/main/programs/autocorrect.nix

`treefmt.config.programs.autocorrect.settings.spellcheck.words`

Correct Words (Case insensitive) for by Spellcheck.

Typenull or (list of string)

Defaultnull

Example

[
  "GitHub"
  "App Store"
  "AppStore = App Store"
  "Git"
  "Node.js"
  "nodejs = Node.js"
  "VIM"
  "DNS"
  "HTTP"
  "SSL"
]

Declared intreefmt-nix/blob/main/programs/autocorrect.nix

`treefmt.config.programs.autocorrect.settings.textRules`

Configure special rules for some texts.

Typenull or (attribute set of (null or one of "off", "error", "warning"))

Defaultnull

Example

{
  "Hello你好" = "warning";
  "Hi你好" = "off";
}

`treefmt.config.programs.biome.settings`

Raw Biome configuration (must conform to Biome JSON schema)

TypeJSON value

Default{ }

Example

{
  formatter = {
    indentStyle = "space";
    lineWidth = 100;
  };
  javascript = {
    formatter = {
      lineWidth = 120;
      quoteStyle = "single";
    };
  };
  json = {
    formatter = {
      enabled = false;
    };
  };
}

Declared intreefmt-nix/blob/main/programs/biome.nix

`treefmt.config.programs.biome.validate.enable`

Whether to validate treefmt.config.programs.biome.settings.

Typeboolean

Defaulttrue

Examplefalse

Declared intreefmt-nix/blob/main/programs/biome.nix

`treefmt.config.programs.biome.validate.schema`

The biome schema file to validate against

Typeabsolute path

Default

Fetches `"https://biomejs.dev/schemas/${biomeVersion}/schema.json"` using `pkgs.fetchurl`.

Example

pkgs.fetchurl {
  url = "https://biomejs.dev/schemas/2.1.2/schema.json"
  hash = "sha256-n4Y16J7g34e0VdQzRItu/P7n5oppkY4Vm4P1pQxOILU=";
}

Path to detekt configuration file

Typenull or absolute path

Defaultnull

Example"./detekt-config.yml"

Declared intreefmt-nix/blob/main/programs/detekt.nix

`treefmt.config.programs.detekt.enable`

Whether to enable detekt.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/detekt.nix

`treefmt.config.programs.dfmt.enable`

Whether to enable dfmt.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/dfmt.nix

`treefmt.config.programs.dhall.enable`

Whether to enable dhall.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/dhall.nix

`treefmt.config.programs.dhall.lint`

Whether to lint in addition to formatting.

Typeboolean

Defaultfalse

Declared intreefmt-nix/blob/main/programs/dhall.nix

`treefmt.config.programs.djlint.enable`

Whether to enable djlint.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/djlint.nix

`treefmt.config.programs.djlint.ignoreRules`

Which H-rules to ignore

Typelist of string

Default[ ]

Declared intreefmt-nix/blob/main/programs/djlint.nix

`treefmt.config.programs.djlint.indent`

Default indentation depth in spaces

Typeunsigned integer, meaning >=0

Default4

Declared intreefmt-nix/blob/main/programs/djlint.nix

Typenull or (list of string)

Defaultnull

Example

# (recommended) using plugins from nixpkgs
# plugins is the list of all available dprint plugins in nixpkgs
(pkgs.dprint-plugins.getPluginList (
  plugins: with plugins; [
    dprint-plugin-toml
    dprint-plugin-dockerfile
    g-plane-pretty_yaml
    # (pkgs.callPackage ./dprint/plugins/sample.nix {})
  ]
))
# (not recommended) using url plugins
# treefmt then only works outside the nix sandbox, so treefmt nix flake check will fail
++ [
  "https://plugins.dprint.dev/json-0.17.2.wasm"
  "https://plugins.dprint.dev/markdown-0.15.2.wasm"
  "https://plugins.dprint.dev/typescript-0.84.4.wasm"
]

Declared intreefmt-nix/blob/main/programs/erlfmt.nix

`treefmt.config.programs.fantomas.dotnet-sdk`

The dotnet-sdk package to use.

Typepackage

Defaultpkgs.dotnet-sdk

Declared intreefmt-nix/blob/main/programs/fantomas.nix

`treefmt.config.programs.fantomas.enable`

Whether to enable fantomas.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/fantomas.nix

`treefmt.config.programs.fish_indent.enable`

Whether to enable fish_indent.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/fish_indent.nix

`treefmt.config.programs.flake-edit.enable`

Whether to enable flake-edit.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/flake-edit.nix

`treefmt.config.programs.flake-edit.noLock`

Skip updating the lockfile after editing flake.nix

Typeboolean

Defaultfalse

Declared intreefmt-nix/blob/main/programs/flake-edit.nix

`treefmt.config.programs.flake-edit.settings.follow.aliases`

Mapping of canonical input names to alternative names. Allows nested inputs like "nixpkgs-lib" to follow "nixpkgs".

Typeattribute set of list of string

Default{ }

Example

{
  nixpkgs = [
    "nixpkgs-lib"
  ];
}

Declared intreefmt-nix/blob/main/programs/flake-edit.nix

`treefmt.config.programs.flake-edit.settings.follow.ignore`

List of inputs to ignore when following. Supports simple names ("systems") or full paths ("crane.nixpkgs").

Typelist of string

Default[ ]

Example

[
  "systems"
  "crane.flake-utils"
]

Declared intreefmt-nix/blob/main/programs/flake-edit.nix

`treefmt.config.programs.fnlfmt.enable`

Whether to enable fnlfmt.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/fnlfmt.nix

`treefmt.config.programs.formatjson5.enable`

Whether to enable formatjson5.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/formatjson5.nix

`treefmt.config.programs.formatjson5.indent`

Indent by the given number of spaces

Typesigned integer

Default4

Declared intreefmt-nix/blob/main/programs/formatjson5.nix

`treefmt.config.programs.formatjson5.noTrailingCommas`

Suppress trailing commas (otherwise added by default)

Typeboolean

Defaultfalse

Declared intreefmt-nix/blob/main/programs/formatjson5.nix

`treefmt.config.programs.formatjson5.oneElementLines`

Objects or arrays with a single child should collapse to a single line

Typeboolean

Defaultfalse

Declared intreefmt-nix/blob/main/programs/formatjson5.nix

`treefmt.config.programs.formatjson5.sortArrays`

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/gofumpt.nix

`treefmt.config.programs.gofumpt.extra`

Whether to enable extra rules.

Typeboolean

Defaultfalse

Declared intreefmt-nix/blob/main/programs/gofumpt.nix

`treefmt.config.programs.goimports.enable`

Whether to enable goimports.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/goimports.nix

`treefmt.config.programs.golangci-lint.buildTags`

Build tags to use during analysis

Typelist of string

Default[ ]

Example

[
  "integration"
  "e2e"
]

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.concurrency`

Number of CPUs to use (auto-configured by default)

Typenull or signed integer

Defaultnull

Example4

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.configFile`

Path to golangci-lint configuration file

Typenull or string

Defaultnull

Example".golangci.yml"

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.disableLinters`

Disable specific linters

Typelist of string

Default[ ]

Example

[
  "typecheck"
]

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.enable`

Whether to enable golangci-lint.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.enableLinters`

Enable specific linters

Typelist of string

Default[ ]

Example

[
  "govet"
  "errcheck"
  "staticcheck"
]

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.enableOnly`

Override configuration to run only specific linter(s)

Typelist of string

Default[ ]

Example

[
  "govet"
  "gofmt"
]

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.fastOnly`

Run only fast linters from enabled linters set

Typeboolean

Defaultfalse

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.maxIssuesPerLinter`

Maximum issues per linter (default: 50)

Typenull or signed integer

Defaultnull

Example50

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.maxSameIssues`

Maximum count of same issues (default: 3)

Typenull or signed integer

Defaultnull

Example3

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.newFromRev`

Show only new issues created after git revision REV

Typenull or string

Defaultnull

Example"HEAD~1"

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.noConfig`

Don't read any configuration file

Typeboolean

Defaultfalse

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.tests`

Analyze test files

Typeboolean

Defaulttrue

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

`treefmt.config.programs.golangci-lint.timeout`

Timeout for total work (e.g., '5m', '1h', '10s')

Typenull or string

Defaultnull

Example"5m"

Declared intreefmt-nix/blob/main/programs/golangci-lint.nix

The profile to use for isort.

Typestring

Default""

Declared intreefmt-nix/blob/main/programs/isort.nix

`treefmt.config.programs.json-sort-cli.autofix`

Update files with fixes instead of just reporting. Defaults to false.

Typeboolean

Defaultfalse

Declared intreefmt-nix/blob/main/programs/json-sort-cli.nix

`treefmt.config.programs.json-sort-cli.enable`

Whether to enable json-sort-cli.

Typeboolean

Defaultfalse

Exampletrue

Declared intreefmt-nix/blob/main/programs/json-sort-cli.nix

`treefmt.config.programs.json-sort-cli.end-of-line`

Specify the desired line ending for output. Defaults to system line ending. Overrides .editorconfig settings if an .editorconfig is found.

Typenull or one of "lf", "crlf", "cr", "unset"

Defaultnull

Declared intreefmt-nix/blob/main/programs/json-sort-cli.nix

`treefmt.config.programs.json-sort-cli.indent-size`

Number of spaces to indent, or the string "tab" to use tabs. Defaults to 2 spaces. Overrides .editorconfig settings if an .editorconfig is found.

Typesigned integer

Default2

Declared intreefmt-nix/blob/main/programs/json-sort-cli.nix

`treefmt.config.programs.json-sort-cli.indent-style`

Specify the desired indentation style for output. Defaults to space. Overrides .editorconfig settings if an .editorconfig is found.

Typeone of "space", "tab"

Default"space"

Declared intreefmt-nix/blob/main/programs/json-sort-cli.nix

`treefmt.config.programs.mdformat.plugins`

Plugins for mdformat that extend its functionality (for Markdown extensions, formatting code blocks, etc).

See mdformat docs for a (non-exhaustive) list of plugins.

Typefunction that evaluates to a(n) list of package

Default

ps: [ ];

Example

ps: [
  ps.mdformat-footnote
  ps.mdformat-gfm
];

Example

{
  "" = {
    modules = [
      "mymodule"
      "tests"
    ];
  };
  subdir = { };
}

`treefmt.config.programs.mypy.directories.<name>.directory`

Directory to run mypy in

Typestring

Default"‹name›"

`treefmt.config.programs.mypy.directories.<name>.extraPythonPackages`

Extra packages to add to PYTHONPATH

Typelist of package

Default[ ]

Example[ pkgs.python3.pkgs.requests ]

`treefmt.config.programs.mypy.directories.<name>.extraPythonPaths`

Extra paths to add to PYTHONPATH. Paths are interpreted relative to the directory options and are added before extraPythonPackages.

Typelist of string

Default[ ]

Example

[
  "path/to/my/module"
]

`treefmt.config.programs.mypy.directories.<name>.modules`

Modules to check

Typelist of string

Default

[
  ""
]

Example

[
  "mymodule"
  "tests"
]

`treefmt.config.programs.mypy.directories.<name>.options`

Options to pass to mypy

Typelist of string

Default[ ]

Example

[
  "--ignore-missing-imports"
]

`treefmt.config.programs.mypy.enable`

Whether to enable mypy.

Typeboolean

Defaultfalse

Exampletrue