clan-core/docs/site/index.md

hide

hide
navigation toc

:material-home: Welcome to Clan's documentation

Getting Started{ .md-button }

:material-book: Guides

How-to Guides for achieving a certain goal or solving a specific issue.

• Adding more machines

  ---

  Learn how Clan automatically includes machines and Nix files.

• Vars Backend

  ---

  Learn how to manage secrets with vars.

• Inventory

  ---

  Clan's declaration format for running services on one or multiple machines.

• Flake-parts

  ---

  Use Clan with https://flake.parts/

• Contribute

  ---

  Discover how to set up a development environment to contribute to Clan!

• macOS machines

  ---

  Manage macOS machines with nix-darwin

API Reference

Reference API Documentation

• CLI Reference

  ---

  The clan CLI command

• Service Modules

  ---

  An overview of available service modules

• Core

  ---

  The clan core nix module. This is imported when using clan and is the basis of the extra functionality that can be provided.

• (Legacy) Modules

  ---

  An overview of available clanModules

  !!! Example "These will be deprecated soon"