{"id":14967875,"url":"https://github.com/nixos/flake-registry","last_synced_at":"2025-05-07T04:06:42.294Z","repository":{"id":39824990,"uuid":"188108543","full_name":"NixOS/flake-registry","owner":"NixOS","description":"Global registry of Nix flakes","archived":false,"fork":false,"pushed_at":"2025-04-14T09:32:10.000Z","size":55,"stargazers_count":111,"open_issues_count":7,"forks_count":39,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-07T04:06:37.316Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NixOS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"nixos"}},"created_at":"2019-05-22T20:24:50.000Z","updated_at":"2025-04-14T09:32:14.000Z","dependencies_parsed_at":"2025-04-22T04:23:22.195Z","dependency_job_id":"76052d73-82ca-48be-ae8d-de4ab7abbe64","html_url":"https://github.com/NixOS/flake-registry","commit_stats":{"total_commits":52,"total_committers":22,"mean_commits":"2.3636363636363638","dds":0.5961538461538461,"last_synced_commit":"895a65f8d5acf848136ee8fe8e8f736f0d27df96"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NixOS%2Fflake-registry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NixOS%2Fflake-registry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NixOS%2Fflake-registry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NixOS%2Fflake-registry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NixOS","download_url":"https://codeload.github.com/NixOS/flake-registry/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252810273,"owners_count":21807759,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-09-24T13:38:48.470Z","updated_at":"2025-05-07T04:06:42.263Z","avatar_url":"https://github.com/NixOS.png","language":"Shell","funding_links":["https://opencollective.com/nixos"],"categories":[],"sub_categories":[],"readme":"# Nix Flake Registry\n\nWelcome to the Nix Flake Registry repository! This repository contains the default [flake-registry.json](flake-registry.json) file utilized by the Nix CLI. The flake registry serves as a convenient method for the Nix CLI to associate short names with flake URIs, such as linking `nixpkgs` to `github:NixOS/nixpkgs/nixpkgs-unstable`.\n\n## Usage\n\nMapped names from this registry are employed in two distinct contexts:\n\n### CLI\n\nThe registry allows for more concise invocations of `nix run` and other Nix commands.\n\nFor instance, when executing `nix run nixpkgs#hello`, the `nixpkgs` portion is resolved to the corresponding GitHub repository via the registry mapping.\n\n### Flake Inputs\n\nWhen a flake output function refers to an input that has not been explicitly specified, the input is resolved using the registry.\n\nConsider the following minimal `flake.nix` file:\n```nix\n{\n  outputs = { self, nixpkgs }: { };\n}\n```\n\nHere, `self` refers to the flake itself, while `nixpkgs` is resolved automatically through the registry.\n\n\u003e NOTE: Although this feature offers convenience, we recommend explicitly listing all inputs, as the flake registry content may change over time.\n\n## Registry File Format\n\nThe file format is briefly documented here: \u003chttps://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-registry.html#registry-format\u003e.\n\n## Inclusion Policy\n\nInclusion criteria are evaluated based on the following considerations:\n\n1. The namespace has a limited size.\n2. Common names should be avoided to prevent confusion if a user mistypes an input in their `flake.nix` and it resolves to another input via the registry.\n3. The shortcut must offer clear utility to the NixOS ecosystem; it is not intended to showcase random projects.\n4. Project popularity is taken into account.\n\nWhen submitting a PR, please acknowledge and refer to these policy points for\nargumentation.\n\nIf your goal is to get your project listed somewhere, consider submitting it to \u003chttps://github.com/nix-community/awesome-nix/\u003e instead.\n\n\u003e NOTE: Some existing entries may not adhere to this policy due to historical reasons.\n\n## Publication Pipeline\n\nBy default, the Nix CLI is configured to fetch the registry at \u003chttps://channels.nixos.org/flake-registry.json\u003e. This URL is proxied to this repository using Fastly:\n\u003chttps://github.com/NixOS/nixos-org-configurations/blob/72adc59c5ba946c3d4844a920e9beefae12bbd49/terraform/channels.tf#L106-L116\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnixos%2Fflake-registry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnixos%2Fflake-registry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnixos%2Fflake-registry/lists"}