Skip to content

Commands

Global flags

These flags are available on every invocation:

copydeck [OPTIONS] COMMAND [ARGS]...
FlagDescription
-c, --config PATHPath to config file (overrides COPYDECK_CONFIG env var and default)
-v, --verboseIncrease verbosity. Use once for INFO, twice (-vv) for DEBUG
--versionPrint version and exit
--helpShow help

config

Manage the CopyDeck configuration file and sources.

config init

Initialise a new config file at the resolved path. Prompts for confirmation if the file already exists.

Terminal window
copydeck config init

config show

Display the current configuration. Shows all sources, or a single named source.

Terminal window
copydeck config show
copydeck config show --name my-gitlab
OptionDescription
--name NAMEShow only the named source

config new

Add a new source interactively. Prompts for name, type, and all relevant fields.

Terminal window
copydeck config new
copydeck config new --name my-gitlab
OptionDescription
--name NAMEPre-fill the source name (prompted if omitted)

config set

Set a field on an existing source. Fully interactive if KEY and VALUE are omitted.

Terminal window
copydeck config set --name my-gitlab
copydeck config set --name my-gitlab path new-group/templates
Option / ArgumentDescription
--name NAMESource to edit (required)
KEY (positional, optional)Field name to set
VALUE (positional, optional)New value

config delete

Remove a source from the config. Prompts for confirmation unless --auto-approve is set.

Terminal window
copydeck config delete --name my-gitlab
copydeck config delete --name my-gitlab --auto-approve
OptionDescription
--name NAMESource to delete (required)
--auto-approveSkip the confirmation prompt

config edit

Open the config file in $EDITOR (falls back to vim).

Terminal window
copydeck config edit

template

Discover and apply Copier templates from configured sources.

template list

List available Copier templates across all enabled sources, or a single named source. Output is rendered as a table with columns: ID, Name, Description, URL.

Terminal window
copydeck template list
copydeck template list --source my-gitlab
copydeck template list -s my-gitlab
OptionDescription
-s, --source NAMEFilter to a single named source

template new

Apply a template to a directory using Copier.

Terminal window
copydeck template new SOURCE/TEMPLATE
copydeck template new SOURCE/TEMPLATE ./my-project
ArgumentDefaultDescription
SOURCE/TEMPLATErequiredSource name and template name separated by / (e.g. my-gitlab/my-template)
OUTPUT_DIRECTORY. (current directory)Destination directory for generated files

info

Display information about a specific template.

Terminal window
copydeck info TEMPLATE_NAME