Commands

init

Initialise a punkt local repository for storing the clones of the synced dotfiles (local state). If an URI to a remote repository is provided, the remote repository will be cloned as the local state.

Usage

Shell

punkt init [<options>] [<repo>]

Examples

punkt init
punkt init audrey
punkt init audrey/dotfiles
punkt init --ssh https://github.com/audrey/dotfiles.git
punkt init --ssh --branch main --depth 1 audrey/dotfiles

Options

Flag	Description
`--ssh`	Use SSH instead of HTTPS

Common Options

Prop

Type

If both --include and --exclude are specified, their intersection is used.

Global Options

Prop

Type

ignored

List path matcher patterns that are ignored by Punkt so that they will not be synced to local state.

list

List files and directories managed within Punkt's local state.