All checks were successful
buildbot/nix-build .#checks.x86_64-linux.clan-dep-git Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-bash Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-fakeroot Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-e2fsprogs Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-age Build done.
buildbot/nix-build .#checks.x86_64-linux.check-for-breakpoints Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-nix Build done.
buildbot/nix-build .#checks.aarch64-darwin.nixos-test_install_machine Build done.
buildbot/nix-build .#checks.aarch64-darwin.nixos-test-backup Build done.
buildbot/nix-build .#checks.x86_64-linux.borgbackup Build done.
buildbot/nix-build .#checks.x86_64-linux.nixos-test-backup Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.package-module-docs Build done.
buildbot/nix-build .#checks.aarch64-linux.nixos-test_install_machine Build done.
buildbot/nix-build .#checks.x86_64-linux.renderClanOptions Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-openssh Build done.
buildbot/nix-build .#checks.x86_64-linux."clan-dep-python3.11-mypy" Build done.
buildbot/nix-build .#checks.x86_64-linux."clan-dep-python3.11-qemu" Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-rsync Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-sops Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-sshpass Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-tor Build done.
buildbot/nix-build .#checks.aarch64-darwin.nixos-flash-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-dep-zbar Build done.
buildbot/nix-build .#checks.aarch64-linux.nixos-test-backup Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-vm-manager-no-breakpoints Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-pytest-without-core Build done.
buildbot/nix-build .#checks.aarch64-linux.nixos-flash-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-clan-cli Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-default Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-webview-ui Build done.
buildbot/nix-build .#checks.aarch64-linux.nixos-iso-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.devShell-clan-vm-manager Build done.
buildbot/nix-build .#checks.x86_64-linux.lib-jsonschema-example-valid Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-vm-manager-pytest Build done.
buildbot/nix-build .#checks.x86_64-linux.container Build done.
buildbot/nix-build .#checks.x86_64-linux.matrix-synapse Build done.
buildbot/nix-build .#checks.x86_64-linux.package-clan-cli Build done.
buildbot/nix-build .#checks.x86_64-linux.package-clan-cli-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.deltachat Build done.
buildbot/nix-build .#checks.x86_64-linux.nixos-iso-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.package-clan-vm-manager Build done.
buildbot/nix-build .#checks.x86_64-linux.package-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.nixos-flash-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.package-default Build done.
buildbot/nix-build .#checks.x86_64-linux.treefmt Build done.
buildbot/nix-build .#checks.x86_64-linux.module-schema Build done.
buildbot/nix-build .#checks.x86_64-linux.package-impure-checks Build done.
buildbot/nix-build .#checks.x86_64-linux.nixos-test_install_machine Build done.
buildbot/nix-build .#checks.x86_64-linux.lib-jsonschema-nix-unit-tests Build done.
buildbot/nix-build .#checks.x86_64-linux.package-merge-after-ci Build done.
buildbot/nix-build .#checks.x86_64-linux.package-moonlight-sunshine-accept Build done.
buildbot/nix-build .#checks.x86_64-linux.package-pending-reviews Build done.
buildbot/nix-build .#checks.x86_64-linux.package-tea-create-pr Build done.
buildbot/nix-build .#checks.x86_64-linux.package-wayland-proxy-virtwl Build done.
buildbot/nix-build .#checks.aarch64-darwin.nixos-iso-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.package-webview-ui Build done.
buildbot/nix-build .#checks.x86_64-linux.package-zerotier-members Build done.
buildbot/nix-build .#checks.x86_64-linux.package-deploy-docs Build done.
buildbot/nix-build .#checks.x86_64-linux.package-zerotierone Build done.
buildbot/nix-build .#checks.x86_64-linux.package-zt-tcp-relay Build done.
buildbot/nix-build .#checks.x86_64-linux.package-function-schema Build done.
buildbot/nix-build .#checks.x86_64-linux.package-module-schema Build done.
buildbot/nix-build .#checks.x86_64-linux.wayland-proxy-virtwl Build done.
buildbot/nix-build .#checks.x86_64-linux.clan-pytest-with-core Build done.
buildbot/nix-build .#checks.x86_64-linux.zt-tcp-relay Build done.
buildbot/nix-build .#checks.x86_64-linux.secrets Build done.
buildbot/nix-build .#checks.x86_64-linux.syncthing Build done.
buildbot/nix-build .#checks.x86_64-linux.package-iso-installer Build done.
buildbot/nix-build .#checks.x86_64-linux.test-backups Build done.
checks / checks-impure (pull_request) Successful in 2m29s
buildbot/nix-build .#checks.x86_64-linux.test-installation Build done.
buildbot/nix-eval Build done.
103 lines
2.2 KiB
Markdown
103 lines
2.2 KiB
Markdown
# Setup
|
|
|
|
Create your own clan with these initial steps and manage a fleet of machines with one single testable git repository!
|
|
|
|
### Prerequisites
|
|
|
|
=== "**Linux**"
|
|
|
|
Clan depends on nix installed on your system. Run the following command to install nix.
|
|
|
|
```bash
|
|
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
|
|
```
|
|
|
|
=== "**NixOS**"
|
|
|
|
If you run NixOS the `nix` binary is already installed.
|
|
|
|
You will also need to enable the `flakes` and `nix-commands` experimental features.
|
|
|
|
```bash
|
|
# /etc/nix/nix.conf or ~/.config/nix/nix.conf
|
|
experimental-features = nix-command flakes
|
|
```
|
|
|
|
=== "**Other**"
|
|
|
|
Clan doesn't offer dedicated support for other operating systems yet.
|
|
|
|
### Step 1: Add Clan CLI to Your Shell
|
|
|
|
Add the Clan CLI into your development workflow:
|
|
|
|
```bash
|
|
nix shell git+https://git.clan.lol/clan/clan-core#clan-cli
|
|
```
|
|
|
|
You can find reference documentation for the `clan` cli program [here](./reference/cli/index.md).
|
|
|
|
Alternatively you can check out the help pages directly:
|
|
```terminalSession
|
|
clan --help
|
|
```
|
|
|
|
### Step 2: Initialize Your Project
|
|
|
|
Set the foundation of your Clan project by initializing it as follows:
|
|
|
|
```bash
|
|
clan flakes create my-clan
|
|
```
|
|
|
|
This command creates the `flake.nix` and `.clan-flake` files for your project.
|
|
It will also generate files from a default template, to help show general clan usage patterns.
|
|
|
|
### Step 3: Verify the Project Structure
|
|
|
|
Ensure that all project files exist by running:
|
|
|
|
```bash
|
|
cd my-clan
|
|
tree
|
|
```
|
|
|
|
This should yield the following:
|
|
|
|
``` { .console .no-copy }
|
|
.
|
|
├── flake.nix
|
|
├── machines
|
|
│ ├── jon
|
|
│ │ ├── configuration.nix
|
|
│ │ └── hardware-configuration.nix
|
|
│ └── sara
|
|
│ ├── configuration.nix
|
|
│ └── hardware-configuration.nix
|
|
└── modules
|
|
└── shared.nix
|
|
|
|
5 directories, 6 files
|
|
```
|
|
|
|
```bash
|
|
clan machines list
|
|
```
|
|
|
|
``` { .console .no-copy }
|
|
jon
|
|
sara
|
|
```
|
|
|
|
!!! success
|
|
|
|
You just successfully bootstrapped your first clan directory.
|
|
|
|
---
|
|
|
|
### What's Next?
|
|
|
|
- [**Installer**](getting-started/installer.md): Setting up new computers remotely is easy with an USB stick.
|
|
|
|
---
|