Skip to main content

Initialize Command

The initialize command creates a new dottie.yaml configuration file with a starter template.

Coming Soon

This command is currently in development. Documentation will be updated when the feature is released.

Planned Usage

> dottie init [options]

Planned Options

OptionShortDescription
--output-oOutput file path (default: dottie.yaml)
--template-tTemplate to use (minimal, standard, full)
--force-fOverwrite existing file

Planned Templates

Minimal

A bare-bones configuration to get started:

profiles:
default:
dotfiles: []
install:
apt: []

Standard (Default)

A typical configuration with common patterns:

profiles:
default:
dotfiles:
- source: dotfiles/.bashrc
target: ~/.bashrc
install:
apt:
- git
- curl

Full

A comprehensive example showing all features:

profiles:
default:
dotfiles:
- source: dotfiles/.bashrc
target: ~/.bashrc
install:
apt: [git, curl]
github:
- repo: BurntSushi/ripgrep
asset: ripgrep-{arch}-unknown-linux-musl.tar.gz
binary: rg
scripts: []
fonts: []
snaps: []
aptRepos: []

work:
extends: default
dotfiles:
- source: dotfiles/.work-config
target: ~/.work-config

Current Workaround

Until init is available, manually create a dottie.yaml file:

touch dottie.yaml

Then add the starter configuration from the Quick Start guide.