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. What's 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. Using Vars
      3. Backends
        1. SOPS
          1. Age Plugins
          2. Secrets
        2. age
      4. Concepts
      5. Advanced Examples
      6. Troubleshooting
    4. Backups
      1. Introduction to Backups
      2. More on Backups
    5. Networking
      1. Networking
      2. Mesh Vpn
    6. Nixpkgs Flake Input
    7. Flake Parts
    8. NixOS Rebuild
    9. NixOS specialisations
    10. macOS
    11. Templates
      1. Templates
      2. Community
    12. 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
    13. Build Host
    14. SSH Agent Forwarding
    15. Private Flake Inputs
    16. Disk Encryption
    17. Secure Boot
    18. 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. data-mesher
      5. dm-dns
      6. dyndns
      7. emergency-access
      8. garage
      9. hello-world
      10. importer
      11. installer
      12. internet
      13. kde
      14. localbackup
      15. matrix-synapse
      16. monitoring
      17. mycelium
      18. ncps
      19. p2p-ssh-iroh
      20. packages
      21. pki
      22. sshd
      23. syncthing
      24. tor
      25. trusted-nix-caches
      26. users
      27. wifi
      28. wireguard
      29. yggdrasil
      30. 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
Need help? Reach out to our community.