{"id":14968053,"url":"https://github.com/instantos/instantnix","last_synced_at":"2025-10-26T00:30:53.083Z","repository":{"id":42682406,"uuid":"278353880","full_name":"instantOS/instantNIX","owner":"instantOS","description":"instantOS tools packaged for the Nix package manager (and NixOS)","archived":false,"fork":false,"pushed_at":"2024-07-08T05:53:25.000Z","size":528,"stargazers_count":33,"open_issues_count":8,"forks_count":5,"subscribers_count":4,"default_branch":"dev","last_synced_at":"2024-10-30T02:48:12.428Z","etag":null,"topics":["instantos","nix","nixpkgs","nur"],"latest_commit_sha":null,"homepage":"","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/instantOS.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2020-07-09T12:07:05.000Z","updated_at":"2024-10-29T20:12:27.000Z","dependencies_parsed_at":"2023-10-04T12:13:51.440Z","dependency_job_id":"7eec5d61-ed38-48b1-bb0f-8aaad1963333","html_url":"https://github.com/instantOS/instantNIX","commit_stats":{"total_commits":327,"total_committers":13,"mean_commits":"25.153846153846153","dds":"0.27828746177370034","last_synced_commit":"73fbe4d2a75d857c8e58211da59bf23cbd267364"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantOS%2FinstantNIX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantOS%2FinstantNIX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantOS%2FinstantNIX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantOS%2FinstantNIX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/instantOS","download_url":"https://codeload.github.com/instantOS/instantNIX/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238229940,"owners_count":19437723,"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":["instantos","nix","nixpkgs","nur"],"created_at":"2024-09-24T13:39:10.297Z","updated_at":"2025-10-26T00:30:52.710Z","avatar_url":"https://github.com/instantOS.png","language":"Nix","funding_links":[],"categories":[],"sub_categories":[],"readme":"**Currently, instantNIX is [not actively maintained](https://github.com/instantOS/instantNIX/issues/32) and based on an outdated version of [nixpkgs](https://github.com/NixOS/nixpkgs).\nPull-requests, however, are welcome and likely to be reviewed.**\n\n\u003cdiv align=\"center\"\u003e\n    \u003ch1\u003einstantNIX\u003c/h1\u003e\n    \u003cp\u003einstantOS port to Nix\u003c/p\u003e\n    \u003cimg width=\"300\" height=\"300\" src=\"https://raw.githubusercontent.com/instantOS/instantLOGO/master/png/nix.png\"\u003e\n\u003c/div\u003e\n\n-------\n\n[![CI builds](https://github.com/instantOS/instantNIX/actions/workflows/ci.yml/badge.svg)](https://github.com/instantOS/instantNIX/actions/workflows/ci.yml)\n[![Cachix Cache](https://img.shields.io/badge/cachix-instantos-blue.svg)](https://instantos.cachix.org)\n\n[InstantOS](https://instantos.github.io/) window manager and tools packaged for Nix and NixOS.\n[Nix](https://nixos.org/explore.html) is your friendly, reproducible package manager and build tool for the experienced user.\nNix, and therefore **instantNIX,** too, works on most Linux distributions and some versions of macOS.\n\n[![InstantOS beta5 preview](https://img.youtube.com/vi/zqcEv3bdIAM/0.jpg)](http://www.youtube.com/watch?v=zqcEv3bdIAM)\n\n**InstantNix** is a sub-repository to the [Nix User Repository (NUR)](https://github.com/nix-community/NUR),\na community-maintained meta-repository.\nInstantNIX is **not** part of [Nixpkgs](https://github.com/nixos/nixpkgs) (yet).\n\nPlease note, that our parent project instantOS is still in beta phase,\nand we are even more so.\nWe also struggle to keep things anywhere near up to date.\nNot everything will work out of the box and some extra setup might be required.\nThat being said, we've never had a change that broke startup and basic functionality.\nKnock on wood!\n\nNix itself is not for the faint of heart or people adverse to tinkering and learning\nor those who are hard-pressed for time.\nDo not expect a polished, well-kept end-product.\n\nWe will strive to get InstantNIX into [Nixpkgs](https://github.com/nixos/nixpkgs),\nthe official Nix package repository, soon after instantOS releases its version 1.0.\nThen, NUR-acrobatics will no longer be required.\n\n# Usage\n\nDetailed instructions on how to install and use instantOS tools with Nix or\non NixOS can be found in the [instantNix Wiki](https://github.com/instantOS/instantNIX/wiki).\nWe even have a section on [Installing instantNIX on a Raspberry Pi](https://github.com/instantOS/instantNIX/wiki/instantNIX-on-a-Raspberry-Pi-4B).\nIn this Readme we only give you a very quick overview.\nCurrently, there are two approaches:\n\n- cloning the repo\n- installing from the Nix User Repository (NUR)\n\nIn both cases, first [install Nix](https://nixos.org/nix/manual/#chap-installation)\non your system if not already installed:\n\n```console\ncurl -L https://nixos.org/nix/install | sh\n```\n\nCurrently, you will have the least manual configuration to do if you use NixOS as a base\n(the Nix universal package manager and build system works on many Linux Distributions and MacOS).\n\n# Installation from Clone\n\nClone this repository and change directory into it.\nFrom there, run:\n\n```nix\nnix-env -iA instantnix -f default.nix --arg pkgs 'import \u003cnixpkgs\u003e {}'\n```\n\nThe last part, starting at \"`--arg`\" is recommended.\nIt causes the build to run from your version of\n[nixpkgs](https://github.com/nixos/nixpkgs)\nrather than the fixed commit of the last tagged stable version,\nwhich can be up to six month old.\n\nAfter installation, you can run `instantwm`,\njust as you would run [dwm](https://dwm.suckless.org) on your system.\nFor many people that means putting `startinstantos` in your `~/.xinitrc`.\nSee an example in `./utils/xinitrc`.\n\nSome related resources:\n - [dwm on ubuntu](https://cannibalcandy.wordpress.com/2012/04/26/installing-and-configuring-dwm-under-ubuntu/)\n - [dwm on lightdm](https://blkct.wordpress.com/2017/06/16/how-to-start-dwm-from-lightdm/)\n\nNote: Some additional configuration steps such as installing optional software\nor setting the correct UID for instantLOCK might be required for everything to\nwork.\nPermissions are an issue on some systems.\n\n# Installation via NUR\n\nAccessing NUR can be done easily.\nJust add the following to `~/.config/nixpkgs/config.nix`:\n\n```nix\n{\n  packageOverrides = pkgs: {\n  # For nixos' `configuration.nix`, replace above line by:\n  #nixpkgs.config.packageOverrides = pkgs: {\n    nur = import (builtins.fetchTarball \"https://github.com/nix-community/NUR/archive/master.tar.gz\") {\n      inherit pkgs;\n    };\n  };\n}\n```\n\nThen you can add `nur.repos.instantos.PACKAGE_NAME` to your `configuration.nix`\nor install **InstantOs** packages via:\n\n```console\n$ nix-env -f '\u003cnixpkgs\u003e' -iA nur.repos.instantos.PACKAGE_NAME  # \"nur.repos.instantos.instantnix\" for all the instantOS packages\n```\n\n# Faster installation with cachix\n\nYou may want to install cachix and take advantage of the build artefact caching with:\n\n```console\n$ nix-env -iA cachix -f https://cachix.org/api/v1/install\n$ cachix use instantos\n```\n\nThat way Nix does not compile as much from source and rather uses pre-compiled\npackages from [cachix](https://cachix.org).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstantos%2Finstantnix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstantos%2Finstantnix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstantos%2Finstantnix/lists"}