Welcome to Clan's documentation
Tutorials
Learning-oriented adventures with a hands-on experience.
-
Set up in 15 minutes
Create your own clan and get everything running in minutes
-
Authoring Modules
Create clanModules that can be reused by the community.
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 facts.
-
Clan's declaration format for running services on one or multiple machines.
-
Use clan with https://flake-parts.dev
-
Discover how to set up a development environment to contribute to Clan!
API Reference
Auto generated API Documentation
-
Learn how to interface with Clan programmatically