Welcome to Clan's documentation
Guides
How-to Guides for achieving a certain goal or solving a specific issue.
-
Learn how Clan automatically includes machines and Nix files.
-
Learn how to manage secrets with vars.
-
Clan's declaration format for running services on one or multiple machines.
-
Use Clan with https://flake.parts/
-
Discover how to set up a development environment to contribute to Clan!
-
Manage macOS machines with nix-darwin
API Reference
Reference API Documentation
-
The
clan
CLI command -
An overview of available service modules
-
The clan core nix module. This is imported when using clan and is the basis of the extra functionality that can be provided.
-
An overview of available clanModules
These will be deprecated soon