Docs
  1. Home
  2. Getting Started
    1. Install Nix and direnv
    2. Quick Start
    3. Install on Physical Machine
    4. Install in VirtualBox
    5. Install on AWS
    6. Install on Google Cloud
    7. Install on Hetzner
    8. Create an SSH Key
    9. Whats Next
  3. Guides
    1. Inventory
      1. Introduction to the Inventory
      2. Autoincludes
    2. Services
      1. Introduction to Clan Services
      2. Community
      3. Exports
      4. Internal SSL Services
    3. Vars
      1. Introduction to Clan Vars
      2. Backend
        1. Vars Backend
        2. Sops Backend
          1. Age Plugins
          2. Secrets
        3. Age Backend
          1. Age Backend
      3. Concepts
      4. Advanced Examples
      5. Troubleshooting
    4. Backups
      1. Backup Intro
      2. Minimal Example
      3. Digging Deeper
      4. Advanced Example
    5. Networking
      1. Networking
      2. Mesh Vpn
    6. Nixpkgs Flake Input
    7. Flake Parts
    8. NixOS Rebuild
    9. MacOS
    10. Templates
      1. Templates
      2. Community
    11. Migrations
      1. Convert Existing NixOS Configuration
      2. How to Rename a Clan Machine
      3. Migrate Admin Service
      4. Migrate Inventory Services
      5. Migration Facts Vars
      6. Disk Id
    12. Build Host
    13. SSH Agent Forwarding
    14. Private Flake Inputs
    15. Disk Encryption
    16. Secure Boot
    17. Contributing
      1. Contributing
      2. Writing Documentation
      3. Debugging
      4. Testing
      5. Styleguide
  4. Reference
    1. Overview
    2. Options
      1. Clan Options
      2. Inventory Submodule
      3. Clan service
    3. clan.core (Machine Options)
      1. clan.core
      2. backups
      3. deployment
      4. image
      5. networking
      6. postgresql
      7. settings
      8. sops
      9. state
      10. vars
    4. CLI
      1. CLI Overview
      2. Backups
      3. Flash
      4. Init
      5. Machines
      6. Secrets
      7. Select
      8. Show
      9. Ssh
      10. State
      11. Templates
      12. Vars
    5. Clanlib
    6. Decisions
      1. Architecture Decisions
      2. 01 Clan Modules
      3. 02 Clan As Library
      4. 03 Adr Numbering Process
      5. 04 Fetching Nix From Python
      6. 05 Deployment Parameters
      7. Title
    7. Glossary
    8. Releases
      1. 25 11
  5. Services
    1. Definition
    2. Official
      1. admin
      2. borgbackup
      3. certificates
      4. coredns
      5. data-mesher
      6. dm-dns
      7. dyndns
      8. emergency-access
      9. garage
      10. hello-world
      11. importer
      12. installer
      13. internet
      14. kde
      15. localbackup
      16. matrix-synapse
      17. monitoring
      18. mycelium
      19. ncps
      20. p2p-ssh-iroh
      21. packages
      22. pki
      23. sshd
      24. syncthing
      25. tor
      26. trusted-nix-caches
      27. users
      28. wifi
      29. wireguard
      30. yggdrasil
      31. zerotier
    3. Community
  1. Overview

CLI Overview

Overview🔗

  • backups

    Manage backups of clan machines

  • flash

    Flashes your machine to an USB drive

  • init

    Initialize a new clan

  • machines

    Manage machines and their configuration

  • secrets

    Manage secrets

  • select

    Select nixos values from the flake

  • show

    Show meta information about the clan

  • ssh

    Ssh to a remote machine

  • state

    Query state information about machines

  • templates

    Interact with templates

  • vars

    Manage vars

Previous
vars
Next
Backups