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 profile with tools, packages, dotfiles, and git config already in place.

  2. Make it yours

    Edit the files inside profiles/kit/ to match what you want on your machine:

    • Directoryprofiles/kit/
      • 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
        • link.env - symlinks everything in this folder to ~/
      • Directorygit/
        • config.txt - set your name and email
    • dotkit.env - global variables (e.g. DOTKIT_DEV_DIR)

    You can also rename “kit” to whatever you’d like your profile to be called.

  3. Bootstrap a new machine

    On any new machine:

    Terminal window
    curl dotkit.run/sh | sh

    The installer clones your dotkit repo and runs dotkit apply.

  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”