Getting Started
Ready to create your own Clan and manage a fleet of machines? Follow these simple steps to get started.
By the end of this guide, you'll have a fresh NixOS configuration ready to push to one or more machines. You'll create a new Git repository and a flake, and all you need is at least one machine to push to. This is the easiest way to begin, and we recommend you to copy your existing configuration into this new setup!
Prerequisites
Clan requires Nix to be installed on your system. Run the following command to install Nix:
If you have previously installed Nix, make sure experimental-features = nix-command flakes
is present in ~/.config/nix/nix.conf
or /etc/nix/nix.conf
. If this is not the case, please add it to ~/.config/nix/nix.conf
.
If you run NixOS the nix
binary is already installed.
You will also need to enable the nix-command
and flakes
experimental features in your configuration.nix
:
Clan requires Nix to be installed on your system. Run the following command to install Nix:
If you have previously installed Nix, make sure experimental-features = nix-command flakes
is present in ~/.config/nix/nix.conf
or /etc/nix/nix.conf
. If this is not the case, please add it to ~/.config/nix/nix.conf
.
Add Clan CLI to Your Shell
Create a new clan
This should prompt for a name:
Enter a name, confirm with enter. A directory with that name will be created and initialized.
Note
This command uses the default
template
See clan templates list
and the --help
reference for how to use other templates.
Explore the Project Structure
Take a look at all project files:
For example, you might see something like:
Donβt worry if your output looks different β Clan templates evolve over time.
To interact with your newly created clan the you need to load the clan
cli-package it into your environment by running:
- prerequisite: install nix-direnv
verify that you can run clan
commands:
You should see something like this:
To change the name of your clan edit meta.name
in the clan.nix
or flake.nix
file