deckctl source
Handles source lifecycle. Sources are persisted to config.yaml — see the
configuration reference.
Synopsis
Section titled “Synopsis”deckctl source [command] [flags]| Subcommand | Purpose |
|---|---|
list | List configured sources |
get | Show one source |
add | Add a source |
remove | Remove a source |
All subcommands also accept the global flags.
deckctl source list
Section titled “deckctl source list”deckctl source list [flags]No command-specific flags. Table columns: Name, Type, Path, TokenEnv,
URL.
deckctl source listdeckctl source list -o jsondeckctl source get
Section titled “deckctl source get”deckctl source get [name] [flags]Takes the source name as a positional argument. Same columns as list.
deckctl source get workdeckctl source get work -o jsondeckctl source add
Section titled “deckctl source add”deckctl source add [flags]| Flag | Description |
|---|---|
-n, --name <name> | Source name — how you refer to it with --source |
-t, --type <type> | local or gitlab |
-p, --path <path> | Local directory (required for local) |
--url <url> | GitLab base URL (required for gitlab) |
-g, --group <path> | GitLab group path, nesting allowed (required for gitlab) |
--env <VAR> | Name of the environment variable holding the token |
Run it with no flags to be prompted for each field.
# Localdeckctl source add --name local --type local --path ~/templates
# Public GitLab group, no tokendeckctl source add --name public --type gitlab \ --url https://gitlab.com --group my-public-group
# Private / self-hosteddeckctl source add --name work --type gitlab \ --url https://gitlab.mycompany.com \ --group platform/templates \ --env DECKCTL_WORK_TOKEN
# Interactivedeckctl source adddeckctl source remove
Section titled “deckctl source remove”deckctl source remove [flags]| Flag | Default | Description |
|---|---|---|
-n, --name <name> | — | Source to remove |
--auto-approve | false | Skip the confirmation prompt |
deckctl source remove --name workdeckctl source remove --name work --auto-approveRemoving a source does not delete its cached templates. Clear those separately:
deckctl cache clear --source work --auto-approve