{"id":13837884,"url":"https://github.com/nix-community/nixago","last_synced_at":"2026-02-11T13:34:20.731Z","repository":{"id":36973949,"uuid":"496849925","full_name":"nix-community/nixago","owner":"nix-community","description":"Generate configuration files using Nix [maintainer=@jmgilman] ","archived":false,"fork":false,"pushed_at":"2025-05-09T14:40:54.000Z","size":2634,"stargazers_count":150,"open_issues_count":10,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2026-01-29T10:15:13.947Z","etag":null,"topics":["cuelang","developer-tools","development","development-environment","nix"],"latest_commit_sha":null,"homepage":"https://nix-community.github.io/nixago","language":"Nix","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nix-community.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"open_collective":"nix-community"}},"created_at":"2022-05-27T03:33:46.000Z","updated_at":"2026-01-28T16:30:07.000Z","dependencies_parsed_at":"2024-04-15T06:48:33.493Z","dependency_job_id":"85a8bf9c-2dc0-41f0-8e46-dd2b16c9bdfe","html_url":"https://github.com/nix-community/nixago","commit_stats":{"total_commits":104,"total_committers":6,"mean_commits":"17.333333333333332","dds":0.1923076923076923,"last_synced_commit":"5133633e9fe6b144c8e00e3b212cdbd5a173b63d"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/nix-community/nixago","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nix-community%2Fnixago","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nix-community%2Fnixago/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nix-community%2Fnixago/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nix-community%2Fnixago/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nix-community","download_url":"https://codeload.github.com/nix-community/nixago/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nix-community%2Fnixago/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29333565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T12:42:24.625Z","status":"ssl_error","status_checked_at":"2026-02-11T12:41:23.344Z","response_time":97,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cuelang","developer-tools","development","development-environment","nix"],"created_at":"2024-08-04T15:01:29.289Z","updated_at":"2026-02-11T13:34:20.716Z","avatar_url":"https://github.com/nix-community.png","language":"Nix","funding_links":["https://opencollective.com/nix-community"],"categories":["Nix","nix"],"sub_categories":[],"readme":"![logo](logo.svg)\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/nix-community/nixago/actions/workflows/ci.yml\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/workflow/status/nix-community/nixago/CI?label=CI\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://nix-community.github.io/nixago\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/workflow/status/nix-community/nixago/CI?label=Docs\"/\u003e\n    \u003c/a\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/nix-community/nixago\"/\u003e\n    \u003ca href=\"https://builtwithnix.org\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/-Built%20with%20Nix-green\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003e Generate configuration files using [Nix][1].\n\nReady to dynamically generate configuration files in your flake-based setup?\nNixago is a flake library for generating configuration files using Nix\nexpressions as the data source.\n\n## Features\n\n- Specify configuration data using native [Nix][1] syntax\n- Generate configuration files using any of the [supported engines][2]\n- Places all artifacts in the Nix store\n- [Extensions][3] are provided for getting started\n\n## Usage\n\nAdd Nixago as an input to your `flake.nix`:\n\n```nix\n{\n  inputs = {\n    # ...\n    nixpkgs.url = \"github:nixos/nixpkgs\";\n    nixago.url = \"github:jmgilman/nixago\";\n    nixago.inputs.nixpkgs.follows = \"nixpkgs\";\n    # ...\n  };\n}\n```\n\n### Generate a Configuration\n\nNixago offers [various engines][2] which can be used for transforming input data\ninto an output file. Nixago will default to the [nix engine][4] that utilizes\n`pkgs.formats` from [nixpkgs][5].\n\n```nix\nlet\n  data = {\n    \"field1\" = \"value1\";\n    \"field2\" = true;\n  };\nin\nnixago.lib.make {\n  inherit data;\n  output = \"config.json\";\n  format = \"json\"; # Optional if it matches the file extension\n  engine = nixago.engines.nix { }; # Optional as this is the default engine\n}\n```\n\nThe result of this invocation will be an attribute set with two attributes:\n\n- `configFile`: A derivation for building the configuration file.\n- `shellHook`: A shell hook for managing the file.\n\nBuilding the derivation produces a file with the following output:\n\n```json\n{\n  \"field1\": \"value1\",\n  \"field2\": true\n}\n```\n\nThe `make` function takes an attribute set that supports the options defined in\nthe [request module][6]. Please refer to the module definition for all of the\navailable options.\n\n### Using the Shell Hook\n\nThe generated shell hook will link the generated configuration file to one of\ntwo places:\n\n- If `$PRJ_ROOT` is defined, the file will be linked to `$PRJ_ROOT/{output}`\n  where `output` is the relative path defined in the call to `make`.\n- If `$PRJ_ROOT` is not defined, the file will be linked to `./{output}`, where\n  the relative path is determined by where the Nix CLI was invoked.\n\nFor example, if `$PRJ_ROOT` is set to `/home/user/code/myprj` and the output is\nspecified as `configs/config.json` then the file will be linked to\n`/home/user/code/myprj/configs/config.json`.\n\nThe shell hook is designed to be integrated into a development shell:\n\n```nix\n{\n  # ...\n  devShells = {\n    default = pkgs.mkShell {\n      shellHook = (nixago.lib.make config).shellHook;\n    };\n  };\n # ...\n}\n```\n\nThis will ensure the file is generated and linked when you enter the shell. The\nbehavior of the hook can be modified via the [available options][7].\n\nSee [the documentation][8] for further configuration details.\n\n## Extending Nixago\n\nAn [additional repository][9] is available that provides extensions for Nixago.\nThese simplify the process of generating configuration files for common\ndevelopment tools.\n\n## Testing\n\nTests are run with:\n\n```shell\nnix flake check\n```\n\n## Contributing\n\n[Read this][10], check out the [issues][11] for items needing attention or\nsubmit your own, and then:\n\n1. Fork the repo (\u003chttps://github.com/nix-community/nixago/fork\u003e)\n2. Create your feature branch (git checkout -b feature/fooBar)\n3. Commit your changes (git commit -am 'Add some fooBar')\n4. Push to the branch (git push origin feature/fooBar)\n5. Create a new Pull Request\n\n[1]: https://nixos.org/\n[2]: https://nix-community.github.io/nixago/engines/index.html\n[3]: https://github.com/nix-community/nixago-extensions\n[4]: https://nix-community.github.io/nixago/engines/nix.html\n[5]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/pkgs-lib/formats.nix\n[6]: https://github.com/nix-community/nixago/blob/master/modules/request.nix\n[7]: https://github.com/nix-community/nixago/blob/master/modules/request.nix#L8\n[8]: https://nix-community.github.io/nixago/introduction.html\n[9]: https://github.com/nix-community/nixago-extensions\n[10]: https://nix-community.github.io/nixago/contributing\n[11]: https://github.com/nix-community/nixago/issues\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnix-community%2Fnixago","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnix-community%2Fnixago","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnix-community%2Fnixago/lists"}