Skip to main content

Configure Skaff

Skaff reads configuration from three sources, merged in this order: environment variables, ~/.config/skaff/settings.json, and runtime flags. Use the CLI to keep everything aligned.

Manage settings

# add directories that contain template repositories
skaff config add ~/skaff-example-templates TEMPLATE_DIR_PATHS

# add a GitHub repository (defaults to the main branch)
skaff config add github:timonteutelink/skaff-example-templates TEMPLATE_DIR_PATHS

# optionally tell Skaff where to find existing projects
skaff config add ~/code PROJECT_SEARCH_PATHS

# change the package runner exposed to template commands
skaff config set NPM_PATH bunx

# inspect the current configuration
skaff config get --format table

Move the configuration file by exporting SKAFF_CONFIG_PATH before running commands.

Load template repositories

Clone or refresh templates on demand:

skaff template load github:org/templates
skaff template list --format table

Skaff caches repositories under ~/.cache/skaff. Use skaff template reload to fetch the latest commits or skaff template erase-cache to clear stale copies.