CLI Reference

Synopsis

deckctl [command] [subcommand] [flags]

Go CLI tool for managing and applying templates across multiple sources: local filesystem, GitLab.com, and self-hosted GitLab instances.

Command tree

deckctl
├── source       list · get · add · remove
├── template     list · variables · apply
├── theme        list · get · active · add · set · remove
├── history      list · clear
├── cache        list · clear
├── validate
└── completion   bash · zsh · fish · powershell

Command	Purpose
source	Manage where templates come from
template	List, inspect and apply templates
theme	Manage output colour palettes
history	Read and clear the apply history
cache	Inspect and clear the template cache
validate	Validate config, themes and sidecars
completion	Emit a shell completion script (standard Cobra command)

Global flags

These are persistent flags — valid on every command.

Flag	Default	Environment variable	Description
--config <path>	~/.config/deckctl/config.yaml	DECKCTL_CONFIG	Sources config file
--theme <path>	~/.config/deckctl/themes.yaml	DECKCTL_THEME	Themes file
--history <path>	~/.config/deckctl/history.db	DECKCTL_HISTORY	Apply-history database
--cache-dir <path>	~/.cache/deckctl/	DECKCTL_CACHE_DIR	Template cache directory
--sidecar <name>	deckctl.yaml	—	Sidecar filename to look for inside a template
--concurrency <n>	1	—	Worker goroutines for scanning local sources (1 = sequential)
-o, --output <mode>	table	—	table or json
-h, --help	—	—	Help for the current command
-v, --version	—	—	Print version, commit and build date

A flag always takes precedence over its environment variable, which takes precedence over the default. The cache directory additionally honours XDG_CACHE_HOME before falling back to ~/.cache/deckctl/.

Note

Passing --sidecar <name> forces the native sidecar format even under --sidecar-format auto. See Copier compatibility.

Output and streams

• Tables and JSON go to stdout.
• Warnings, prompts and diagnostics go to stderr.
• deckctl validate exits non-zero when any check fails; other commands exit non-zero on error.

Version

deckctl --version

deckctl v0.2.0 (commit <sha>, built <rfc3339-timestamp>)

Release binaries carry a real version, commit and build date. A binary built with plain go build reports dev; one installed with go install ...@v0.2.0 reports the module version.

See also

• Configuration reference — config.yaml and themes.yaml
• Sidecar reference — deckctl.yaml
• Changelog