State

query state information about machines

Usage: clan state

Commands

• list: list state folders and the services that configure them

This subcommand provides an interface to the state managed by clan.

State can be folders and databases that modules depend on managed by clan.

State directories can be added to on a per machine basis:

  config.clanCore.state.[SERVICE_NAME].folders = [
    "/home"
    "/root"
  ];

Here [SERVICE_NAME] can be set freely, if the user sets them extra userdata can be a good choice.

Examples

$ clan state list [MACHINE]

List state of the machines managed by clan.

For more detailed information, visit: getting-started

State list

list state folders and the services that configure them

Usage: clan state list

Positional arguments

1. machine: The machine to list state files for

Options

• --service: the service to show state files for
• --debug: Enable debug logging
• --option: <('name', 'value')> Nix option to set
• --flake: <PATH> path to the flake where the clan resides in, can be a remote flake or local, can be set through the [CLAN_DIR] environment variable