wiki/getting-started.md
2024-05-07 22:21:16 +00:00

1.9 KiB

title description published date tags editor dateCreated
Getting Started Guide A quick guide to getting started with installing and using Auxolotl. true 2024-05-07T22:21:14.335Z installation, tutorial markdown 2024-05-05T15:44:03.224Z

Getting Started With Auxolotl

There are a few ways you can get started with Aux:

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

Download from GitHub

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.