wiki/getting-started.md

75 lines
1.9 KiB
Markdown
Raw Normal View History

2024-05-05 15:44:05 +00:00
---
title: Getting Started Guide
description: A quick guide to getting started with installing and using Auxolotl.
published: true
2024-05-07 22:21:16 +00:00
date: 2024-05-07T22:21:14.335Z
2024-05-05 15:44:05 +00:00
tags: installation, tutorial
editor: markdown
dateCreated: 2024-05-05T15:44:03.224Z
---
2024-05-05 17:53:55 +00:00
# Getting Started With Auxolotl
2024-05-05 15:44:05 +00:00
There are a few ways you can get started with Aux:
2024-05-05 17:53:55 +00:00
- [I want to install the full distribution.](#installing-the-aux-distribution)
2024-05-05 15:44:05 +00:00
- [I want to convert my existing NixOS install to Auxolotl](#converting-nixos-to-aux)
2024-05-05 17:53:55 +00:00
- [I just want to install the Aux package manager and command-line tool.](#installing-the-aux-command-line-tool)
2024-05-05 15:44:05 +00:00
2024-05-07 22:21:16 +00:00
Other ways to use Aux:
- [Flake templates](#flake-templates)
2024-05-05 15:44:05 +00:00
## Installing the Aux command-line tool
Open a terminal and run this command to install Aux:
```shell=
$ TODO
```
Verify the installation by running this command:
```shell=
$ TODO
```
## Converting NixOS to Aux
2024-05-06 09:35:15 +00:00
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:
```shell=
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
2024-05-05 15:44:05 +00:00
Open your `flake.nix` file and change the following line:
```nix
nixpkgs.url = "github:NixOS/nixpkgs/nixos-<release>";
```
to:
```nix
nixpkgs.url = "github:auxolotl/nixpkgs/nixos-<release>";
```
## Installing the Aux distribution
2024-05-07 22:21:16 +00:00
==TODO==
## Other ways to use Aux
### Flake templates
[Download from GitHub](https://github.com/auxolotl/templates)
Aux provides [templates](https://github.com/auxolotl/templates) for you to use to bootstrap a default Nix system with Aux. These include templates for Linux, Darwin (macOS), and home-manager.