2.3 KiB
| title | description | published | date | tags | editor | dateCreated |
|---|---|---|---|---|---|---|
| Getting Started Guide | A quick guide to getting started with installing and using Auxolotl. | false | 2024-05-11T20:30:05.302Z | installation, tutorial | markdown | 2024-05-05T15:44:03.224Z |
This page is outdated After the roadmap changes this page should no longer refer to
auxolotl/nixpkgs. It would be good to have a migration guide, but it would require serious modification of this page. Do not follow the instructions on this page. It is only available to logged-in users. {.is-danger}
Getting Started With Auxolotl
There are a few ways you can get started with Aux:
- I want to install the full distribution.
- I want to convert my existing NixOS install to Auxolotl
- I just want to install the Aux package manager and command-line tool.
Other ways to use Aux:
Installing the Aux command-line tool
Open a terminal and run this command to install Aux:
$ TODO
Verify the installation by running this command:
$ TODO
Converting NixOS to Aux
If you have an existing NixOS installation and want to convert it to use Aux, all you need to do is change your nixpkgs source to use the Auxolotl nixpkgs repository (substituting <release> with desired release - such as unstable or 23.11).
Channels
To change your nixpkgs channel to pull from Aux, run the following command:
nix-channel --add https://github.com/auxolotl/nixpkgs/nixos-<release> nixpkgs
On your next nix-channel --update or nixos-rebuild --upgrade, Aux will get pulled.
Flakes
Open your flake.nix file and change the following line:
nixpkgs.url = "github:NixOS/nixpkgs/nixos-<release>";
to:
nixpkgs.url = "github:auxolotl/nixpkgs/nixos-<release>";
Installing the Aux distribution
==TODO==
Other ways to use Aux
Flake templates
Aux provides templates for you to use to bootstrap a default Nix system with Aux. These include templates for Linux, Darwin (macOS), and home-manager.