Skip to content
dotkit

Quick Start

Get from zero to a configured machine in four steps.

  1. Fork the example repo

    Go to dotkit-run/example and use it as a template or fork it. Name the repo dotkit.

    It has a working kit with tools, packages, dotfiles, and git config already in place.

  2. Make it yours

    Edit the files to match what you want on your machine:

    • example.dotkit - the entry point, says what runs and in what order
    • Directorytools/
      • community.txt - tools to install (brew, node, rust, uv)
    • Directorypackages/
      • brew.md - Homebrew formulae and casks
    • Directorydotfiles/
      • .zshrc, .gitignore_global - replace with your own dotfiles
    • Directorygit/
      • config.txt - set your name and email
    • dotkit.env - variables shared by everything in the kit

    Rename example.dotkit to whatever you want the kit called. Add a second one, say work.dotkit, and you will be asked which to run.

  3. Bootstrap a new machine

    On any new machine:

    Terminal window
    curl -fsSL dotkit.run/sh | sh

    The installer clones your dotkit repo and runs your kit.

  4. Add new packages

    When you install something new, add it to your dotkit at the same time:

    Terminal window
    dotkit add packages/brew neovim

    This adds neovim to the map block in brew.txt / brew.md and installs it immediately. Keep your dotkit up to date with your changes.

Next steps

Section titled “Next steps”