Init

Initialize a new clan

Usage: clan init

Positional arguments

1. name: Name of the clan to create. If not provided, will prompt for a name.

Options

• --template: (Default: default) Reference to the template to use for the clan. default="default". In the format <flake_ref>#template_name Where <flake_ref> is a flake reference (e.g. github:org/repo) or a local path (e.g. '.' ). Omitting <flake_ref># will use the builtin templates (e.g. just 'default' from clan-core ).
• --no-git: Do not setup git
• --domain: Domain for the clan. Used for internal service routing as <hostname>.<domain>. If not provided, will prompt (defaults to 'clan').
• --no-update: Do not update the clan flake
• --user: The user to generate the keys for. Default: logged-in OS username (e.g. from $LOGNAME or system)
• --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

Examples🔗

$ clan init my-clan

Will create a new clan in the directory 'my-clan' using the default template.

$ clan init my-clan --template=minimal

Will create a new clan using the 'minimal' template.

$ clan init . --no-git

Will create a new clan in the current directory without setting up git.

For more detailed information, visit: getting-started