{"apps": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Applications indexed by their `name`.", "loc": ["perSystem", "forge", "apps"], "readOnly": false, "type": "attribute set of (submodule)"}, "apps.<name>.broken": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether the app is broken.", "loc": ["perSystem", "forge", "apps", "<name>", "broken"], "readOnly": false, "type": "boolean"}, "apps.<name>.data": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Data to be re-used in an application.\n\nEach entry can either be a path to an existing file, or a literal\nstring, which are both normalized into a `{ name, content, path }`\nattribute set.\n\nFor strings, `path` automatically resolves to a file in the Nix store containing the string content.\n", "example": {"_type": "literalExpression", "text": "{\n  configFile = ./app.conf;\n  greetingMessage = \"hello world\";\n  testFile = {\n    name = \"my-test-file.txt\";\n    path = ./test/file.txt;\n  };\n}\n"}, "loc": ["perSystem", "forge", "apps", "<name>", "data"], "readOnly": false, "type": "lazy attribute set of ((submodule) or (absolute path or string) convertible to it)"}, "apps.<name>.data.<name>.content": {"declarations": [], "default": {"_type": "literalExpression", "text": "lib.optionalString (config.path != null) (lib.removeSuffix \"\\n\" (lib.readFile config.path))"}, "description": "Data item content.", "loc": ["perSystem", "forge", "apps", "<name>", "data", "<name>", "content"], "readOnly": false, "type": "string"}, "apps.<name>.data.<name>.name": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\u2039name\u203a\""}, "description": "Data item name.\n\nDefaults to the file's basename when sourced from a path, or to the\nattribute name otherwise.\n", "loc": ["perSystem", "forge", "apps", "<name>", "data", "<name>", "name"], "readOnly": false, "type": "string"}, "apps.<name>.data.<name>.path": {"declarations": [], "default": {"_type": "literalExpression", "text": "pkgs.writeText config.name config.content"}, "description": "Data item absolute path.", "loc": ["perSystem", "forge", "apps", "<name>", "data", "<name>", "path"], "readOnly": false, "type": "absolute path"}, "apps.<name>.description": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Short application description. Maximum 120 characters.", "example": {"_type": "literalExpression", "text": "\"A fast and secure web server for self-hosted applications.\""}, "loc": ["perSystem", "forge", "apps", "<name>", "description"], "readOnly": false, "type": "string matching the pattern ^$|^.{1,119}\\.$"}, "apps.<name>.displayName": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\u2039name\u203a\""}, "description": "Human readable application name. Defaults to `name` if not set.", "example": {"_type": "literalExpression", "text": "\"My Hello Application\""}, "loc": ["perSystem", "forge", "apps", "<name>", "displayName"], "readOnly": false, "type": "string"}, "apps.<name>.icon": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to application icon in SVG format. If not specified, a default icon\nwill be used.\n", "example": {"_type": "literalExpression", "text": "./icon.svg"}, "loc": ["perSystem", "forge", "apps", "<name>", "icon"], "readOnly": false, "type": "null or absolute path"}, "apps.<name>.links": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Links related to this project.", "loc": ["perSystem", "forge", "apps", "<name>", "links"], "readOnly": false, "type": "submodule"}, "apps.<name>.links.docs": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Project documentation URL.", "example": {"_type": "literalExpression", "text": "\"https://example.com/docs\""}, "loc": ["perSystem", "forge", "apps", "<name>", "links", "docs"], "readOnly": false, "type": "null or string matching the pattern [a-zA-Z][a-zA-Z0-9+-.]*://[^ \t\n]+"}, "apps.<name>.links.source": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Project source code URL.", "example": {"_type": "literalExpression", "text": "\"https://github.com/example/project\""}, "loc": ["perSystem", "forge", "apps", "<name>", "links", "source"], "readOnly": false, "type": "null or string matching the pattern [a-zA-Z][a-zA-Z0-9+-.]*://[^ \t\n]+"}, "apps.<name>.links.website": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Project website URL.", "example": {"_type": "literalExpression", "text": "\"https://example.com\""}, "loc": ["perSystem", "forge", "apps", "<name>", "links", "website"], "readOnly": false, "type": "null or string matching the pattern [a-zA-Z][a-zA-Z0-9+-.]*://[^ \t\n]+"}, "apps.<name>.maintainers": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of the maintainers of this application.\n\nMaintainers needs to be either a Nixpkgs maintainer or a NGI Forge\nmaintainer defined in `maintainers/maintainer-list.nix` file.\n", "example": {"_type": "literalExpression", "text": "with lib.maintainers; [ ngi-nix ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "maintainers"], "readOnly": false, "type": "list of anything"}, "apps.<name>.ngi": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "NGI specific options.", "loc": ["perSystem", "forge", "apps", "<name>", "ngi"], "readOnly": false, "type": "submodule"}, "apps.<name>.ngi.grants": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "NGI grants supporting this project.", "loc": ["perSystem", "forge", "apps", "<name>", "ngi", "grants"], "readOnly": false, "type": "submodule"}, "apps.<name>.ngi.grants.Commons": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "list of subgrants under the Commons fund.", "example": {"_type": "literalExpression", "text": "[\n  \"Hello-rust\"\n]"}, "loc": ["perSystem", "forge", "apps", "<name>", "ngi", "grants", "Commons"], "readOnly": false, "type": "list of string"}, "apps.<name>.ngi.grants.Core": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "list of subgrants under the Core fund.", "example": {"_type": "literalExpression", "text": "[\n  \"Hello-rust\"\n]"}, "loc": ["perSystem", "forge", "apps", "<name>", "ngi", "grants", "Core"], "readOnly": false, "type": "list of string"}, "apps.<name>.ngi.grants.Entrust": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "list of subgrants under the Entrust fund.", "example": {"_type": "literalExpression", "text": "[\n  \"Hello-rust\"\n]"}, "loc": ["perSystem", "forge", "apps", "<name>", "ngi", "grants", "Entrust"], "readOnly": false, "type": "list of string"}, "apps.<name>.ngi.grants.Review": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "list of subgrants under the Review fund.", "example": {"_type": "literalExpression", "text": "[\n  \"Hello-rust\"\n]"}, "loc": ["perSystem", "forge", "apps", "<name>", "ngi", "grants", "Review"], "readOnly": false, "type": "list of string"}, "apps.<name>.programs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Programs configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "programs"], "readOnly": false, "type": "submodule"}, "apps.<name>.programs.mainPackage": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Package launched by the _program_ runtime.", "example": {"_type": "literalExpression", "text": "pkgs.hello"}, "loc": ["perSystem", "forge", "apps", "<name>", "programs", "mainPackage"], "readOnly": false, "type": "null or package"}, "apps.<name>.programs.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Packages to include in the _shell_ runtime.", "example": {"_type": "literalExpression", "text": "[ pkgs.curl pkgs.jq ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "programs", "packages"], "readOnly": false, "type": "list of package"}, "apps.<name>.programs.runtimes": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Program runtimes.", "loc": ["perSystem", "forge", "apps", "<name>", "programs", "runtimes"], "readOnly": false, "type": "submodule"}, "apps.<name>.programs.runtimes.program.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Program runtime\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "apps", "<name>", "programs", "runtimes", "program", "enable"], "readOnly": false, "type": "boolean"}, "apps.<name>.programs.runtimes.shell.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Shell runtime\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "apps", "<name>", "programs", "runtimes", "shell", "enable"], "readOnly": false, "type": "boolean"}, "apps.<name>.services": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Services configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "services"], "readOnly": false, "type": "submodule"}, "apps.<name>.services.components": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Services components.\n\nEach component must have `process.command` set and can optionally\ndeclare one or more `resources` providing NixOS configuration.\n", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components"], "readOnly": false, "type": "attribute set of (submodule)"}, "apps.<name>.services.components.<name>.dependsOn": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of service components that need to be started before this one.\n", "example": {"_type": "literalExpression", "text": "[ \"foobar-server\" ]\n"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "dependsOn"], "readOnly": false, "type": "list of string"}, "apps.<name>.services.components.<name>.healthcheck": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Health check configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "healthcheck"], "readOnly": false, "type": "submodule"}, "apps.<name>.services.components.<name>.healthcheck.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable health check.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "healthcheck", "enable"], "readOnly": false, "type": "boolean"}, "apps.<name>.services.components.<name>.healthcheck.interval": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"30s\""}, "description": "Time between health checks.", "example": {"_type": "literalExpression", "text": "\"1m\""}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "healthcheck", "interval"], "readOnly": false, "type": "string"}, "apps.<name>.services.components.<name>.healthcheck.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of packages available to the health check command.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.curl pkgs.jq ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "healthcheck", "packages"], "readOnly": false, "type": "list of package"}, "apps.<name>.services.components.<name>.healthcheck.retries": {"declarations": [], "default": {"_type": "literalExpression", "text": "3"}, "description": "Number of consecutive failures needed to consider the service unhealthy.", "example": {"_type": "literalExpression", "text": "5"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "healthcheck", "retries"], "readOnly": false, "type": "signed integer"}, "apps.<name>.services.components.<name>.healthcheck.startPeriod": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"0s\""}, "description": "Initialization period during which health check failures are not counted.", "example": {"_type": "literalExpression", "text": "\"30s\""}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "healthcheck", "startPeriod"], "readOnly": false, "type": "string"}, "apps.<name>.services.components.<name>.healthcheck.test": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Command to run to check health, as a list of strings (direct exec, no shell).\n", "example": {"_type": "literalExpression", "text": "[ \"${lib.getExe pkgs.curl}\" \"-fs\" \"http://localhost:5000/\" ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "healthcheck", "test"], "readOnly": false, "type": "list of string"}, "apps.<name>.services.components.<name>.healthcheck.timeout": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"30s\""}, "description": "Time to wait for a health check to succeed before considering it failed.", "example": {"_type": "literalExpression", "text": "\"10s\""}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "healthcheck", "timeout"], "readOnly": false, "type": "string"}, "apps.<name>.services.components.<name>.process": {"declarations": [], "description": "Process configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process"], "readOnly": false, "type": "submodule"}, "apps.<name>.services.components.<name>.process.argv": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of arguments that will be passed to the main program.", "example": {"_type": "literalExpression", "text": "[\n  \"--config\"\n  \"service.toml\"\n]"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "argv"], "readOnly": false, "type": "list of (optionally newline-terminated) single-line string"}, "apps.<name>.services.components.<name>.process.command": {"declarations": [], "description": "Main command used to launch the service.\n\nCan be a package (e.g. `pkgs.hello`) or an explicit binary path.\n", "example": {"_type": "literalExpression", "text": "\"${pkgs.hello}/bin/hello\""}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "command"], "readOnly": false, "type": "package or string"}, "apps.<name>.services.components.<name>.process.configData": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration data files for the service\n\nThese files are made available to the service and can be updated without restarting the service process, enabling configuration reloading.\nThe service manager implementation determines how these files are exposed to the service (e.g., via a specific directory path).\nThis path is available in the `path` sub-option for each `configData.<name>` entry.\n\nThis is particularly useful for services that support configuration reloading via signals (e.g., SIGHUP) or which pick up changes automatically, so that no downtime is required in order to reload the service.\n", "example": {"_type": "literalExpression", "text": "{\n  \"server.conf\" = {\n    text = ''\n      port = 8080\n      workers = 4\n    '';\n  };\n  \"ssl/cert.pem\" = {\n    source = ./cert.pem;\n  };\n}\n"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "configData"], "readOnly": false, "type": "lazy attribute set of (submodule)"}, "apps.<name>.services.components.<name>.process.configData.<name>.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether this configuration file should be generated.\nThis option allows specific configuration files to be disabled.\n", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "configData", "<name>", "enable"], "readOnly": false, "type": "boolean"}, "apps.<name>.services.components.<name>.process.configData.<name>.name": {"declarations": [], "description": "Name of the configuration file (relative to the service's configuration directory). Defaults to the attribute name.\n", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "configData", "<name>", "name"], "readOnly": false, "type": "string"}, "apps.<name>.services.components.<name>.process.configData.<name>.path": {"declarations": [], "description": "The actual path where this configuration file will be available.\nThis is determined by the service manager implementation.\n\nOn NixOS it is an absolute path.\nOther service managers may provide a relative path, in order to be unprivileged and/or relocatable.\n", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "configData", "<name>", "path"], "readOnly": true, "type": "string"}, "apps.<name>.services.components.<name>.process.configData.<name>.source": {"declarations": [], "description": "Path of the source file.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "configData", "<name>", "source"], "readOnly": false, "type": "absolute path"}, "apps.<name>.services.components.<name>.process.configData.<name>.text": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Text content of the configuration file.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "configData", "<name>", "text"], "readOnly": false, "type": "null or strings concatenated with \"\\n\""}, "apps.<name>.services.components.<name>.process.environment": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables passed to the service.", "example": {"_type": "literalExpression", "text": "{\n  DEBUG = \"1\";\n  LOG_LEVEL = \"info\";\n}\n"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "environment"], "readOnly": false, "type": "attribute set of string"}, "apps.<name>.services.components.<name>.process.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional packages available for the service.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.rsync pkgs.jq ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "packages"], "readOnly": false, "type": "list of package"}, "apps.<name>.services.components.<name>.process.ports": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of ports exposed by the service.\n\nFormat:\n  _HOST_PORT:SERVICE_PORT_\n", "example": {"_type": "literalExpression", "text": "[ \"8000:8000\" \"5432:5432\" ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "ports"], "readOnly": false, "type": "list of string matching the pattern ^[0-9]+:[0-9]+$"}, "apps.<name>.services.components.<name>.process.preStart": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Script to run before each start of this service.\n\nRuns before every start attempt, including restarts.\nIf the script exits with a non-zero status, the service\nis considered failed and the restart policy applies.\n\nSet to `null` to disable.\n", "example": {"_type": "literalExpression", "text": "''\n  # bash\n  echo \"Running DB migration ...\"\n  program-manage makemigrations && program-manage migrate\n''"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "preStart"], "readOnly": false, "type": "null or string"}, "apps.<name>.services.components.<name>.process.stateDir": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"/var/lib/\u2039name\u203a\""}, "description": "Path to the service state directory.\n", "example": {"_type": "literalExpression", "text": "\"/var/lib/myservice\""}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "stateDir"], "readOnly": false, "type": "string"}, "apps.<name>.services.components.<name>.process.user": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"prefer-dynamic\""}, "description": "User account under which the service runs.\n\n- `root`: service runs as root. A non-privileged user and group named\n  after the service are also created for services that start as root\n  and then drop privileges.\n\n- `prefer-dynamic`: on NixOS runtime , uses `DynamicUser` - no physical\n  user or group account is created. On container runtime, uses a\n  non-privileged user named after the service.\n\n- `non-privileged`: service always runs as a non-privileged user named\n  after the service.\n", "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "process", "user"], "readOnly": false, "type": "one of \"root\", \"prefer-dynamic\", \"non-privileged\""}, "apps.<name>.services.components.<name>.resources": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Resource configuration", "example": {"_type": "literalExpression", "text": "{\n  database.nixosConfig = { services.postgresql.enable = true; };\n  cache.nixosConfig = { services.redis.servers.default.enable = true; };\n}\n"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "resources"], "readOnly": false, "type": "attribute set of (submodule)"}, "apps.<name>.services.components.<name>.resources.<name>.nixosConfig": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Runtime independent configuration of the resource.\n\nSee the list of available\n[NixOS options](https://search.nixos.org/options) .\n", "example": {"_type": "literalExpression", "text": "{ services.postgresql.enable = true; }"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "resources", "<name>", "nixosConfig"], "readOnly": false, "type": "module"}, "apps.<name>.services.components.<name>.resources.<name>.ports": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of ports exposed by the resource.\n\nFormat:\n  _HOST_PORT:RESOURCE_PORT_\n", "example": {"_type": "literalExpression", "text": "[ \"5432:5432\" ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "resources", "<name>", "ports"], "readOnly": false, "type": "list of string matching the pattern ^[0-9]+:[0-9]+$"}, "apps.<name>.services.components.<name>.resources.<name>.role": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"backend\""}, "description": "Role of this resource relative to the component that declares it.\n\n- `backend` (default): the component depends on this resource, so the\n  resource starts before the component. Use this for services the\n  component needs at startup, such as a database or a message queue.\n\n- `frontend`: this resource depends on the component, so the component\n  starts before the resource. Use this for services that sit in front\n  of the component, such as a reverse proxy, which needs the component\n  to be running and resolvable in the container network DNS before it\n  can start.\n", "example": {"_type": "literalExpression", "text": "\"frontend\""}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "components", "<name>", "resources", "<name>", "role"], "readOnly": false, "type": "one of \"backend\", \"frontend\""}, "apps.<name>.services.runtimes": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Portable services runtimes.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes"], "readOnly": false, "type": "submodule"}, "apps.<name>.services.runtimes.container": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Container configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "container"], "readOnly": false, "type": "submodule"}, "apps.<name>.services.runtimes.container.components": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Per-component container runtime configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "container", "components"], "readOnly": false, "type": "attribute set of (submodule)"}, "apps.<name>.services.runtimes.container.components.<name>.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of packages available in the container.\n\nUse this option to add packages required by setup script.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.curl ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "container", "components", "<name>", "packages"], "readOnly": false, "type": "list of package"}, "apps.<name>.services.runtimes.container.components.<name>.setup": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Script to run once at the container startup.\nUse this option for one-off system preparation steps.\n", "example": {"_type": "literalExpression", "text": "''\n  # bash\n  echo \"Creating directory structure ...\"\n  mkdir --parents /var/lib/myservice/config /var/lib/myservice/db\n''"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "container", "components", "<name>", "setup"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "apps.<name>.services.runtimes.container.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Container runtime.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "container", "enable"], "readOnly": false, "type": "boolean"}, "apps.<name>.services.runtimes.container.resources": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Per-resource container runtime NixOS configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "container", "resources"], "readOnly": false, "type": "attribute set of (submodule)"}, "apps.<name>.services.runtimes.container.resources.<name>.nixosConfig": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Container runtime specific configuration.\n\nSee the list of available\n[NixOS options](https://search.nixos.org/options) .\n", "example": {"_type": "literalExpression", "text": "{\n  services.postgresql.enableTCPIP = true;\n  services.postgresql.authentication = ''\n    local all all trust\n    host all all 0.0.0.0/0 trust\n    host all all ::0/0 trust\n  '';\n}\n"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "container", "resources", "<name>", "nixosConfig"], "readOnly": false, "type": "module"}, "apps.<name>.services.runtimes.nixos": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "NixOS system configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "nixos"], "readOnly": false, "type": "submodule"}, "apps.<name>.services.runtimes.nixos.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable NixOS runtime.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "nixos", "enable"], "readOnly": false, "type": "boolean"}, "apps.<name>.services.runtimes.nixos.nixosConfig": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "NixOS runtime specific configuration.\n\nSee the list of available\n[NixOS options](https://search.nixos.org/options) .\n", "example": {"_type": "literalExpression", "text": "{\n  services.postgresql.authentication = ''\n    local all all trust\n  '';\n}\n"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "nixos", "nixosConfig"], "readOnly": false, "type": "module"}, "apps.<name>.services.runtimes.nixos.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of packages available in the NixOS system.\n\nUse this option to add packages required by setup script.\n\nThis is a convenience option equivalent to setting\n`nixosConfig.environment.systemPackages`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.btop ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "nixos", "packages"], "readOnly": false, "type": "list of package"}, "apps.<name>.services.runtimes.nixos.setup": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Script to run once at system startup.\nUse this option for one-off system preparation steps.\n", "example": {"_type": "literalExpression", "text": "''\n  # bash\n  echo \"Creating directory structure ...\"\n  mkdir --parents /var/lib/myservice/config /var/lib/myservice/db\n''"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "nixos", "setup"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "apps.<name>.services.runtimes.nixos.vm.cores": {"declarations": [], "default": {"_type": "literalExpression", "text": "4"}, "description": "Number of CPU cores available to VM.", "example": {"_type": "literalExpression", "text": "8"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "nixos", "vm", "cores"], "readOnly": false, "type": "signed integer"}, "apps.<name>.services.runtimes.nixos.vm.diskSize": {"declarations": [], "default": {"_type": "literalExpression", "text": "4096"}, "description": "VM disk size in MiB.", "example": {"_type": "literalExpression", "text": "10240"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "nixos", "vm", "diskSize"], "readOnly": false, "type": "signed integer"}, "apps.<name>.services.runtimes.nixos.vm.memorySize": {"declarations": [], "default": {"_type": "literalExpression", "text": "2048"}, "description": "VM memory size in MiB.", "example": {"_type": "literalExpression", "text": "4096"}, "loc": ["perSystem", "forge", "apps", "<name>", "services", "runtimes", "nixos", "vm", "memorySize"], "readOnly": false, "type": "signed integer"}, "apps.<name>.test": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Test configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "test"], "readOnly": false, "type": "submodule"}, "apps.<name>.test.programs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Program test configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "test", "programs"], "readOnly": false, "type": "submodule"}, "apps.<name>.test.programs.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of packages available in the test script.", "example": {"_type": "literalExpression", "text": "[ pkgs.curl pkgs.jq ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "test", "programs", "packages"], "readOnly": false, "type": "list of package"}, "apps.<name>.test.programs.script": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Script to test the program runtime.\n\nLaunch tests with:\n\n```\nnix build .#apps.<app-name>.test-programs\n```\n", "example": {"_type": "literalExpression", "text": "''\n  $program --version\n''"}, "loc": ["perSystem", "forge", "apps", "<name>", "test", "programs", "script"], "readOnly": false, "type": "string"}, "apps.<name>.test.services": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Services test configuration.", "loc": ["perSystem", "forge", "apps", "<name>", "test", "services"], "readOnly": false, "type": "submodule"}, "apps.<name>.test.services.nixosConfig": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Extra configuration passed to the NixOS VM running the test.\n\n See the list of available\n [NixOS options](https://search.nixos.org/options) .\n", "example": {"_type": "literalExpression", "text": "{\n  virtualisation.memorySize = 4096;\n  virtualisation.diskSize = 10240;\n}\n"}, "loc": ["perSystem", "forge", "apps", "<name>", "test", "services", "nixosConfig"], "readOnly": false, "type": "module"}, "apps.<name>.test.services.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of packages available in the test script.", "example": {"_type": "literalExpression", "text": "[ pkgs.curl pkgs.jq ]"}, "loc": ["perSystem", "forge", "apps", "<name>", "test", "services", "packages"], "readOnly": false, "type": "list of package"}, "apps.<name>.test.services.sandbox": {"declarations": [], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable the Nix sandbox when running tests.\n\nSet to _false_ to allow internet access during tests, which may be\nrequired when tests need to download additional resources at runtime,\nsuch as container images pulled by compose files.\n\nWhen disabled, tests must be launched with Nix sandbox set to relaxed\nusing following commands:\n\n```\nnix build .#apps.<app-name>.test-services-nixos --option sandbox relaxed --builders \"\"\nnix build .#apps.<app-name>.test-services-container --option sandbox relaxed --builders \"\"\n```\n\nDisabling sandbox can cause problems with test reproducibility.\nUse only when necessary.\n", "loc": ["perSystem", "forge", "apps", "<name>", "test", "services", "sandbox"], "readOnly": false, "type": "boolean"}, "apps.<name>.test.services.script": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Script to test application services inside a NixOS machine or container.\n\nLaunch tests with:\n\n```\nnix build .#apps.<app-name>.test-services-container\nnix build .#apps.<app-name>.test-services-nixos\n```\n", "example": {"_type": "literalExpression", "text": "''\n  curl --fail http://localhost:5000 | grep \"Hello\"\n''"}, "loc": ["perSystem", "forge", "apps", "<name>", "test", "services", "script"], "readOnly": false, "type": "string"}, "apps.<name>.usage": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Application usage description in markdown format.", "example": {"_type": "literalExpression", "text": "''\n  Launch the application in your browser at `http://localhost:8080`.\n  \n  ## Default credentials\n  \n  - Username: `admin`\n  - Password: `admin`\n''"}, "loc": ["perSystem", "forge", "apps", "<name>", "usage"], "readOnly": false, "type": "string"}, "pkgs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Packages indexed by their `pname`.\n\nEach package uses one of the available builders.\nOnly one builder can be enabled per package by setting build.<builder>.enable = true.\n", "loc": ["perSystem", "forge", "pkgs"], "readOnly": false, "type": "attribute set of (submodule)"}, "pkgs.<name>.broken": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether the package is broken.", "loc": ["perSystem", "forge", "pkgs", "<name>", "broken"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build": {"declarations": [], "description": "Package build options.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.debug": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable interactive package build environment for debugging.\n\nLaunch environment:\n\n```\nmkdir dev && cd dev\nnix develop .#pkgs.${package}\n```\n\nand follow instructions.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "debug"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.env.NIX_CFLAGS_COMPILE": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Flags to pass to the C compiler, bypassing help builders.\n\nPrefer to use help builders whenever possible.\nSee <https://github.com/NixOS/nixpkgs/issues/79303>\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "env", "NIX_CFLAGS_COMPILE"], "readOnly": false, "type": "null or (list of string)"}, "pkgs.<name>.build.extraAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Extra attributes merged into the derivation produced by the selected builder.\n\nUse this to pass builder-specific phase hooks (`preConfigure`,\n`postInstall`, \u2026), environment variables, or any other\n`stdenv.mkDerivation` attribute not exposed as a dedicated option.\nAttributes set here take precedence over the builder defaults.\n\nExpert option. For more information see the\n[Nixpkgs manual](https://nixos.org/manual/nixpkgs/unstable/).\n", "example": {"_type": "literalExpression", "text": "{\n  # Set HOME for tools that require a writable home directory\n  preConfigure = \"export HOME=$(mktemp -d)\";\n\n  # Remove unwanted files from the output\n  postInstall = \"rm $out/share/doc/my-package/INSTALL\";\n\n  # Pass extra flags to configure\n  configureFlags = [ \"--disable-static\" \"--enable-shared\" ];\n\n  # Set an environment variable for the build\n  MY_VARIABLE = \"value\";\n}\n"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "extraAttrs"], "readOnly": false, "type": "lazy attribute set of anything"}, "pkgs.<name>.build.goPackageBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.goPackageBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Go module builder for applications and libraries.\n\nUses `buildGoModule` from Nixpkgs, which builds Go modules using the\nstandard Go toolchain with module-aware dependency management.\n\nFor more information, see the\n[Nixpkgs Go documentation](https://nixos.org/manual/nixpkgs/unstable/#sec-language-go)\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.goPackageBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.goPackageBuilder.ldflags": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Linker flags passed to the Go compiler.\n\nCommonly used to embed version information at build time.\n\nMapped to `ldflags`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"-s\"\n  \"-w\"\n  \"-X main.version=1.0.0\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "ldflags"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.goPackageBuilder.modRoot": {"declarations": [], "default": {"_type": "literalExpression", "text": "\".\""}, "description": "Relative path to the directory containing go.mod.\n\nUseful for monorepos where the Go module is not at the repository root.\n\nMapped to `modRoot`.\n", "example": {"_type": "literalExpression", "text": "\"cmd/my-app\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "modRoot"], "readOnly": false, "type": "string"}, "pkgs.<name>.build.goPackageBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.goPackageBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.goPackageBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.goPackageBuilder.proxyVendor": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fetch dependencies via the Go module proxy instead of vendoring from\nsource.\n\nEnable this only when upstream vendoring is incomplete or unsuitable.\n\nMapped to `proxyVendor`.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "proxyVendor"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.goPackageBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.goPackageBuilder.subPackages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Go packages to build.\n\nKeep the default for a single main package, or provide multiple package\npaths.\n\nMapped to `subPackages`.\n", "example": {"_type": "literalExpression", "text": "[\n  \".\"\n  \"./cmd/tool\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "subPackages"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.goPackageBuilder.tags": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Build tags passed to the Go compiler.\n\nMapped to `tags`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"sqlite\"\n  \"netgo\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "tags"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.goPackageBuilder.vendorHash": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Hash of the vendored Go module dependency tree.\n\nLeave empty initially to let Nix print the correct hash on first build.\n\nMapped to `vendorHash`.\n", "example": {"_type": "literalExpression", "text": "\"sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "goPackageBuilder", "vendorHash"], "readOnly": false, "type": "null or string"}, "pkgs.<name>.build.identityBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "identityBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.identityBuilder.derivation": {"declarations": [], "description": "Resulting package derivation.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "identityBuilder", "derivation"], "readOnly": false, "type": "package"}, "pkgs.<name>.build.identityBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Identity builder to provide a derivation directly\n(eg. from Nixpkgs using `pkgs.pkgsOriginal`).\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "identityBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.identityBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "identityBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.identityBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "identityBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.identityBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "identityBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.identityBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "identityBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.identityBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "identityBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.npmPackageBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.npmPackageBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable NPM package builder for JavaScript and TypeScript packages.\n\nUses `buildNpmPackage` from Nixpkgs, which builds Node.js packages\nusing `npm ci` with a locked dependency set from `package-lock.json`.\nNode.js is automatically included as a build-time dependency.\n\nFor more information, see the\n[Nixpkgs Node.js documentation](https://nixos.org/manual/nixpkgs/unstable/#language-javascript)\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.npmPackageBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.npmPackageBuilder.npmDepsHash": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Hash of the npm dependencies fetched from `package-lock.json`.\n\nLeave empty initially to let Nix print the correct hash on first build.\n\nMapped to `npmDepsHash`.\n", "example": {"_type": "literalExpression", "text": "\"sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder", "npmDepsHash"], "readOnly": false, "type": "string"}, "pkgs.<name>.build.npmPackageBuilder.npmInstallFlags": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional flags passed to `npm ci` during the install phase.\n\nMapped to `npmInstallFlags`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"--ignore-scripts\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder", "npmInstallFlags"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.npmPackageBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.npmPackageBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.npmPackageBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.npmPackageBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "npmPackageBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.ocamlBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.ocamlBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable OCaml builder for applications and libraries.\n\nUses `buildDunePackage` from Nixpkgs, which builds OCaml packages with\nDune and installs them through findlib.\n\nFor more information, see the\n[Nixpkgs OCaml documentation](https://nixos.org/manual/nixpkgs/unstable/#sec-language-ocaml)\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.ocamlBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.ocamlBuilder.minimalVersion": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Minimal OCaml version required to build the package.\n\nThe build fails early with an explicit message when `ocamlPackages` provides an\nolder compiler.\n\nMapped to `minimalOCamlVersion`.\n", "example": {"_type": "literalExpression", "text": "\"4.12\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "minimalVersion"], "readOnly": false, "type": "null or string"}, "pkgs.<name>.build.ocamlBuilder.ocamlPackages": {"declarations": [], "default": {"_type": "literalExpression", "text": "pkgs: pkgs.ocaml-ng.ocamlPackages"}, "description": "The OCaml package scope providing the builder and the dependencies.\n\nOverride to build against a different OCaml compiler version. All\ndependencies must be taken from the same scope, otherwise they are\ncompiled for an incompatible compiler version.\n", "example": {"_type": "literalExpression", "text": "pkgs: pkgs.ocaml-ng.ocamlPackages_latest"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "ocamlPackages"], "readOnly": false, "type": "function that evaluates to a(n) (attribute set)"}, "pkgs.<name>.build.ocamlBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.ocamlBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.ocamlBuilder.packages.dependencies": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of dependencies that must be propagated to downstream consumers.\n\nOCaml libraries linked by dependents belong here, so that findlib can\nresolve them transitively.\n\nMapped to `propagatedBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "with pkgs.ocaml-ng.ocamlPackages; [ menhirLib yojson ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "packages", "dependencies"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.ocamlBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.ocamlBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "ocamlBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.pnpmPackageBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.pnpmPackageBuilder.buildScript": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"build\""}, "description": "The pnpm script to run for building (`pnpm run <script>`).\n\nMapped to `buildScript`.\n", "example": {"_type": "literalExpression", "text": "\"build:prod\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "buildScript"], "readOnly": false, "type": "string"}, "pkgs.<name>.build.pnpmPackageBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable PNPM package builder for JavaScript and TypeScript packages.\n\nUses `fetchPnpmDeps` and `stdenvNoCC.mkDerivation` with `pnpmConfigHook`\nfrom Nixpkgs, which builds Node.js packages using pnpm with a locked\ndependency set from `pnpm-lock.yaml`.\nNode.js and pnpm are automatically included as build-time dependencies.\n\nFor more information, see the\n[Nixpkgs Node.js documentation](https://nixos.org/manual/nixpkgs/unstable/#language-javascript)\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.pnpmPackageBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.pnpmPackageBuilder.fetcherVersion": {"declarations": [], "default": {"_type": "literalExpression", "text": "3"}, "description": "Version of the pnpm fetcher to use.\n\nVersion 3 supports pnpm lockfile v9 (pnpm >= 9).\nUse version 1 for older lockfiles.\n\nMapped to `fetcherVersion`.\n", "example": {"_type": "literalExpression", "text": "1"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "fetcherVersion"], "readOnly": false, "type": "signed integer"}, "pkgs.<name>.build.pnpmPackageBuilder.installDir": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "If not null, the directory containing the build output to install into `$out`.\n\nMapped to `installDir`.\n", "example": {"_type": "literalExpression", "text": "\"dist\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "installDir"], "readOnly": false, "type": "null or string"}, "pkgs.<name>.build.pnpmPackageBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pnpmPackageBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pnpmPackageBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pnpmPackageBuilder.pnpm": {"declarations": [], "default": {"_type": "literalExpression", "text": "pkgs.pnpm_10"}, "description": "pnpm package used for fetching and building.\n\nPin pnpm to a specific package to avoid hash mismatch when the\npnpm version in nixpkgs changes.\n\nMapped to `pnpm`.\n", "example": {"_type": "literalExpression", "text": "pkgs.pnpm_9"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "pnpm"], "readOnly": false, "type": "package"}, "pkgs.<name>.build.pnpmPackageBuilder.pnpmDepsHash": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Hash of the fetched pnpm dependencies.\n\nLeave empty initially to let Nix print the correct hash on first build.\n\nMapped to `hash` in `fetchPnpmDeps`.\n", "example": {"_type": "literalExpression", "text": "\"sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "pnpmDepsHash"], "readOnly": false, "type": "string"}, "pkgs.<name>.build.pnpmPackageBuilder.sourceRoot": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to the subdirectory within the source containing `pnpm-lock.yaml`.\n\nUse this for monorepos where the pnpm workspace is not at the repository root.\nFormat: `\"source/<subdir>\"`.\n\nMapped to `sourceRoot`.\n", "example": {"_type": "literalExpression", "text": "\"source/frontend\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "sourceRoot"], "readOnly": false, "type": "null or string"}, "pkgs.<name>.build.pnpmPackageBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pnpmPackageBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.pythonAppBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.pythonAppBuilder.disabledTests": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of pytest test names to skip.\n\nUseful for disabling flaky or network-dependent tests that cannot pass\nin the Nix sandbox.\n\nMapped to `disabledTests`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"test_network\"\n  \"test_integration\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "disabledTests"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.pythonAppBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Python application builder for executable Python programs.\n\nUses `buildPythonApplication` from Nixpkgs, which builds Python packages\nfollowing PEP-517 (`pyproject.toml`) as standalone applications not\nimportable as a dependency by other Python packages.\n\nFor more information, see the\n[Nixpkgs Python documentation](https://nixos.org/manual/nixpkgs/unstable/#python)\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.pythonAppBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.pythonAppBuilder.importsCheck": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Python modules to import-check after installation as a smoke\ntest.\n\nMapped to `pythonImportsCheck`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"myapp\"\n  \"myapp.cli\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "importsCheck"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.pythonAppBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonAppBuilder.packages.build-system": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of PEP-517 build system dependencies (e.g. setuptools, hatchling).\n\nMapped to `build-system`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.python3Packages.setuptools pkgs.python3Packages.wheel ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "packages", "build-system"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonAppBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonAppBuilder.packages.dependencies": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Python runtime dependencies required at runtime (PEP-621).\n\nMapped to `dependencies`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.python3Packages.click pkgs.python3Packages.requests ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "packages", "dependencies"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonAppBuilder.packages.optional-dependencies": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "List of optional Python runtime dependencies grouped by extra name\n(PEP-621 extras).\n\nMapped to `optional-dependencies`.\n", "example": {"_type": "literalExpression", "text": "{\n  dev = [ pkgs.python3Packages.pytest ];\n  redis = [ pkgs.python3Packages.redis ];\n}\n"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "packages", "optional-dependencies"], "readOnly": false, "type": "attribute set of list of package"}, "pkgs.<name>.build.pythonAppBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonAppBuilder.relaxDeps": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Remove version constraints from specified dependencies.\n\nUse when the package specifies strict version bounds that are still\nsatisfied by the versions available in Nixpkgs. Set to `true` to relax\nall dependencies, or list specific dependency names.\n\nMapped to `pythonRelaxDeps`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"click\"\n  \"attrs\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "relaxDeps"], "readOnly": false, "type": "boolean or list of string"}, "pkgs.<name>.build.pythonAppBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonAppBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.pythonPackageBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.pythonPackageBuilder.disabledTests": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of pytest test names to skip.\n\nUseful for disabling flaky or network-dependent tests that cannot pass\nin the Nix sandbox.\n\nMapped to `disabledTests`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"test_network\"\n  \"test_integration\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "disabledTests"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.pythonPackageBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Python package builder for reusable Python libraries.\n\nUses `buildPythonPackage` from Nixpkgs, which builds Python packages\nfollowing PEP-517 (`pyproject.toml`) and makes the result importable\nas a dependency by other Python packages.\n\nFor more information, see the\n[Nixpkgs Python documentation](https://nixos.org/manual/nixpkgs/unstable/#python)\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.pythonPackageBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.pythonPackageBuilder.importsCheck": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Python modules to import-check after installation as a smoke\ntest.\n\nMapped to `pythonImportsCheck`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"requests\"\n  \"requests.auth\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "importsCheck"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.pythonPackageBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonPackageBuilder.packages.build-system": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of PEP-517 build system dependencies (e.g. setuptools, hatchling).\n\nMapped to `build-system`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.python3Packages.setuptools pkgs.python3Packages.wheel ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "packages", "build-system"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonPackageBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonPackageBuilder.packages.dependencies": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Python runtime dependencies required at runtime (PEP-621).\n\nMapped to `dependencies`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.python3Packages.numpy pkgs.python3Packages.attrs ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "packages", "dependencies"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonPackageBuilder.packages.optional-dependencies": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "List of optional Python runtime dependencies grouped by extra name\n(PEP-621 extras).\n\nMapped to `optional-dependencies`.\n", "example": {"_type": "literalExpression", "text": "{\n  dev = [ pkgs.python3Packages.pytest ];\n  redis = [ pkgs.python3Packages.redis ];\n}\n"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "packages", "optional-dependencies"], "readOnly": false, "type": "attribute set of list of package"}, "pkgs.<name>.build.pythonPackageBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.pythonPackageBuilder.relaxDeps": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Remove version constraints from specified dependencies.\n\nUse when the package specifies strict version bounds that are still\nsatisfied by the versions available in Nixpkgs. Set to `true` to relax\nall dependencies, or list specific dependency names.\n\nMapped to `pythonRelaxDeps`.\n", "example": {"_type": "literalExpression", "text": "[\n  \"click\"\n  \"attrs\"\n]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "relaxDeps"], "readOnly": false, "type": "boolean or list of string"}, "pkgs.<name>.build.pythonPackageBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "pythonPackageBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.rustPackageBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.rustPackageBuilder.cargoBuildFlags": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional flags passed to `cargo build`.\n\nMapped to `cargoBuildFlags`.\n", "example": {"_type": "literalExpression", "text": "[ \"--features\" \"enable-feature\" ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder", "cargoBuildFlags"], "readOnly": false, "type": "list of string"}, "pkgs.<name>.build.rustPackageBuilder.cargoHash": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Hash of the Cargo dependencies vendored from `Cargo.lock`.\n\nLeave empty initially to let Nix print the correct hash on first build.\n\nMapped to `cargoHash`.\n", "example": {"_type": "literalExpression", "text": "\"sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder", "cargoHash"], "readOnly": false, "type": "string"}, "pkgs.<name>.build.rustPackageBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Rust package builder for applications and libraries.\n\nUses `rustPlatform.buildRustPackage` from Nixpkgs, which builds Rust\npackages using Cargo with a vendored dependency set locked by `Cargo.lock`.\n\nFor more information, see the\n[Nixpkgs Rust documentation](https://nixos.org/manual/nixpkgs/unstable/#rust)\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.rustPackageBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.rustPackageBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.rustPackageBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.rustPackageBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.rustPackageBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "rustPackageBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.standardBuilder": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "This option has no description.", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "standardBuilder"], "readOnly": false, "type": "submodule"}, "pkgs.<name>.build.standardBuilder.enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Standard builder for autotools, CMake, or Makefile-based projects.\n\nUses `stdenv.mkDerivation` from Nixpkgs, which supports the standard\nGNU build system (`./configure && make && make install`).\n\nFor more information, see the\n[Nixpkgs stdenv documentation](https://nixos.org/manual/nixpkgs/unstable/#chap-stdenv)\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "standardBuilder", "enable"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.build.standardBuilder.env": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Exported environment variables.\n\nMapped to `env`.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "standardBuilder", "env"], "readOnly": false, "type": "open submodule of attribute set of (null or boolean or floating point number or signed integer or package or absolute path or string)"}, "pkgs.<name>.build.standardBuilder.packages.build": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of build-time dependencies needed during compilation (native\narchitecture).\n\nMapped to `nativeBuildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cmake pkgs.pkg-config pkgs.ninja ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "standardBuilder", "packages", "build"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.standardBuilder.packages.check": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of test dependencies needed to run the test suite.\n\nMapped to `nativeCheckInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.cunit ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "standardBuilder", "packages", "check"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.standardBuilder.packages.run": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of runtime dependencies needed by the package (target\narchitecture).\n\nMapped to `buildInputs`.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.openssl pkgs.sqlite pkgs.zlib ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "standardBuilder", "packages", "run"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.build.standardBuilder.stdenv": {"declarations": [], "default": {"_type": "literalExpression", "text": "pkgs.stdenv"}, "description": "The stdenv used for the build.\n\nOverride to use a different compiler toolchain or to strip down the\nbuild environment. For example, use `pkgs.stdenvNoCC` for packages\nthat do not require a C compiler, or `pkgs.clangStdenv` to build\nwith Clang instead of GCC.\n", "example": {"_type": "literalExpression", "text": "pkgs.stdenvNoCC"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "standardBuilder", "stdenv"], "readOnly": false, "type": "package"}, "pkgs.<name>.build.standardBuilder.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "standardBuilder", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.build.structuredAttrs": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes local to the build script.\n\nMapped to themselves as attributes given to the builder.\n\nSee <https://nix.dev/manual/nix/latest/store/derivation/#structured-attrs>.\n", "loc": ["perSystem", "forge", "pkgs", "<name>", "build", "structuredAttrs"], "readOnly": false, "type": "open submodule of attribute set of (structuredAttrs value)"}, "pkgs.<name>.description": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Short package description. Maximum 120 characters.", "example": {"_type": "literalExpression", "text": "\"A program that prints greeting messages.\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "description"], "readOnly": false, "type": "string matching the pattern ^$|^.{1,119}\\.$"}, "pkgs.<name>.develop.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of packages available in the development environment.\n\nAll build inputs are automatically included.\n", "example": {"_type": "literalExpression", "text": "[ pkgs.git pkgs.vim ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "develop", "packages"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.develop.shellHook": {"declarations": [], "default": {"_type": "literalExpression", "text": "''\n  echo -e \"\\nWelcome. This environment contains all dependencies required\"\n  echo \"to build $ENV_PACKAGE_NAME from source.\"\n  echo\n  echo \"Grab the source code from $ENV_PACKAGE_SOURCE\"\n  echo \"or from the upstream repository and you are all set to start hacking.\"\n''"}, "description": "Script which is launched when entering the development environment.\n\nEnter with:\n\n```\nnix develop .#pkgs.${package}.env\n```\n", "example": {"_type": "literalExpression", "text": "''\n  echo \"Welcome to my-package development environment!\"\n  echo \"Run 'make' to build the project\"\n''"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "develop", "shellHook"], "readOnly": false, "type": "string"}, "pkgs.<name>.homePage": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Package home page URL.", "example": {"_type": "literalExpression", "text": "\"https://www.gnu.org/software/hello/\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "homePage"], "readOnly": false, "type": "string matching the pattern [a-zA-Z][a-zA-Z0-9+-.]*://[^ \t\n]+"}, "pkgs.<name>.license": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "License, or licenses, for the package.\n\nCan be a single license (e.g. `lib.licenses.gpl3Only`) or a list of licenses.\n", "example": {"_type": "literalExpression", "text": "[ lib.licenses.mit lib.licenses.asl20 ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "license"], "readOnly": false, "type": "(attribute set) or string or list of ((attribute set) or string)"}, "pkgs.<name>.mainProgram": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Name of the main executable program.", "example": {"_type": "literalExpression", "text": "\"hello\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "mainProgram"], "readOnly": false, "type": "string"}, "pkgs.<name>.maintainers": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of the maintainers of this package.\n\nMaintainers needs to be either a Nixpkgs maintainer or a NGI Forge\nmaintainer defined in `maintainers/maintainer-list.nix` file.\n", "example": {"_type": "literalExpression", "text": "with lib.maintainers; [ ngi-nix ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "maintainers"], "readOnly": false, "type": "list of anything"}, "pkgs.<name>.source.git": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Git repository URL with revision.\n\nSupported forges:\n  - `github:owner/repo/revision`\n  - `gitlab:owner/repo/revision`\n  - `codeberg:owner/repo/revision`\n  - `forgejo:domain/owner/repo/revision`\n  - `gitea:domain/owner/repo/revision`\n  - `git:https://url?rev=hash`\n  - `git:https://url?tag=version`\n", "example": {"_type": "literalExpression", "text": "# GitHub\n\"github:my-user/my-repo/v1.0.0\"\n\n# Codeberg\n\"codeberg:my-user/my-repo/v1.0.0\"\n\n# Self-hosted Forgejo instance\n\"forgejo:git.example.com/my-user/my-repo/v1.0.0\"\n\n# Arbitrary git URL\n\"git:https://git.example.com/my-repo?tag=v1.0.0\"\n"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "source", "git"], "readOnly": false, "type": "null or string matching the pattern ^.*:.*/.*/.*$"}, "pkgs.<name>.source.hash": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Source code hash.\n\nUse empty string to get the hash during a first build.\n", "example": {"_type": "literalExpression", "text": "\"sha256-jZkUKv2SV28wsM18tCqNxoCZmLxdYH2Idh9RLibH2yA=\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "source", "hash"], "readOnly": false, "type": "string"}, "pkgs.<name>.source.patches": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of patch files to be applied to the source code.\n\nPatches are applied in the order specified using the patch command.\n", "example": {"_type": "literalExpression", "text": "[ ./fix-build.patch ./add-feature.patch ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "source", "patches"], "readOnly": false, "type": "list of absolute path"}, "pkgs.<name>.source.path": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Relative path to local source code directory.", "example": {"_type": "literalExpression", "text": "./backend/src"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "source", "path"], "readOnly": false, "type": "null or absolute path"}, "pkgs.<name>.source.submodules": {"declarations": [], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fetch Git submodules along with the repository source.\n\nOnly applicable when using `source.git`.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "source", "submodules"], "readOnly": false, "type": "boolean"}, "pkgs.<name>.source.url": {"declarations": [], "default": {"_type": "literalExpression", "text": "null"}, "description": "Source tarball URL.", "example": {"_type": "literalExpression", "text": "\"https://downloads.my-project/my-package-1.0.0.tar.gz\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "source", "url"], "readOnly": false, "type": "null or string matching the pattern ^.*://.*"}, "pkgs.<name>.test.packages": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of packages available in the test script.", "example": {"_type": "literalExpression", "text": "[ pkgs.curl pkgs.jq ]"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "test", "packages"], "readOnly": false, "type": "list of package"}, "pkgs.<name>.test.script": {"declarations": [], "default": {"_type": "literalExpression", "text": "''\n  echo \"Test script\"\n''"}, "description": "Script to test the package.\nThe package being tested is available in PATH.\n\nLaunch test with:\n\n```\nnix build .#pkgs.${package}.test\n```\n", "example": {"_type": "literalExpression", "text": "''\n  hello | grep \"Hello, world\"\n''"}, "loc": ["perSystem", "forge", "pkgs", "<name>", "test", "script"], "readOnly": false, "type": "string"}, "pkgs.<name>.version": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"1.0.0\""}, "description": "Package version.", "example": {"_type": "literalExpression", "text": "\"2.12.1\""}, "loc": ["perSystem", "forge", "pkgs", "<name>", "version"], "readOnly": false, "type": "string"}}