dotfiles

KO | EN

gitlite — search

#javascript #python #golang #android #machine-learning #rust #docker #macos #java #cli #vue #mcp #openai #open-source

(★ 115)

yup we're doin the thing

File Explorer

Download Latest Version (.zip)

- devcontainer.json
- - actions-lock.json
- - dependency-updater.lock.yml
  - dependency-updater.md
  - full-integration-test.yml
  - lint.yml
  - test.yml
- dependency-updater.md
- - dotf-common.sh
  - post-defaults-hook.sh
  - post-dotfiles-hook.sh
  - pre-defaults-hook.sh
  - unprotect-managed-files.sh
- bootstrap
- dotf
- dotf-ubuntu-gui
- config.yml
- dependency-updater.yml
- mise.version
- - 0001-record-architecture-decisions.md
  - 0002-prefer-mise-as-tool-owner.md
  - 0003-design-for-agent-hostile-security.md
  - 0004-support-macos-admin-macos-non-admin-and-debian.md
  - 0005-separate-config-data-from-step-behavior.md
  - 0006-converge-machines-with-mise-bootstrap.md
  - 0007-separate-convergence-from-dependency-updates.md
- implementing-steps.md
- ubuntu-22.04.md
- - .bash_profile
  - .bashrc
  - .gemrc
  - .gitconfig
  - .gitignore
  - .hushlogin
  - .npmrc
  - .yarnrc.yml
- - ghostty-config.platform
  - platform.fish
  - sudo_local
- - yknotify.sh
  - yubikey-icon.png
- - command.rb
  - command_helpers.rb
  - config.rb
  - debian_desktop_source_installer.rb
  - loader.rb
  - migration.rb
  - migration_runner.rb
  - output_formatter.rb
  - platform_restrictable.rb
  - runner.rb
  - step.rb
  - system_adapter.rb
- - ban_ci_or_noninteractive_method.rb
  - ban_file_system_classes.rb
  - step_public_methods.rb
- dotfiles.rb
- - adopt_mise_bootstrap_migration_test.rb
  - adopt_omniwm_migration_test.rb
  - config_ci_overrides_test.rb
  - config_test.rb
  - debian_desktop_source_installer_test.rb
  - debug_test.rb
  - dotf_cli_test.rb
  - migration_runner_test.rb
  - migration_test.rb
  - move_dotf_run_extension_migration_test.rb
  - move_eza_to_mise_migration_test.rb
  - output_formatter_test.rb
  - platform_restrictable_test.rb
  - remove_factory_droid_migration_test.rb
  - remove_retired_command_line_tools_migration_test.rb
  - runner_test.rb
  - self_manage_mise_migration_test.rb
  - step_test.rb
  - system_adapter_test.rb
- - dotf_update_notice_test.rb
- - dev_env_git_cleanliness_test.rb
  - dev_env_mise_task_flags_test.rb
  - env_to_fnox_migration_test.rb
  - flog_flay_tasks_test.rb
  - github_readme_audit_test.rb
  - skill_creator_scripts_test.rb
- - bootstrap_script_helper.rb
  - config_fixture_helper.rb
  - defaults_test_helper.rb
  - dotf_script_helper.rb
  - fake_runner_step.rb
  - fake_system_adapter.rb
  - fake_system_adapter_test.rb
  - step_test_case.rb
  - system_assertions.rb
- bootstrap_test.rb
- check_human_only_files_test.rb
- config_syntax_test.rb
- dependency_updater_config_test.rb
- dotf_completion_test.rb
- mise_bootstrap_dotfiles_defaults_test.rb
- mise_bootstrap_packages_launchd_test.rb
- omniwm_settings_test.rb
- post_defaults_hook_test.rb
- post_dotfiles_hook_test.rb
- test_helper.rb
- trim_mise_config_test.rb
- unprotect_managed_files_test.rb
- wallpaper_launcher_test.rb
- woodblock_wallpaper_command_test.rb
- - check_dependency_update.rb
  - package_probe.sh
  - run_dotfiles_integration.sh
  - trim_mise_config.rb
- - Dockerfile
  - Dockerfile.gui
  - entrypoint-gui.sh
- check_human_only_files.rb
- lint_agent_skills.rb
.debride-whitelist
.env.example
.gitattributes
.gitignore
.mise.toml
.rubocop-custom.yml
.standard.yml
AGENTS.md
Gemfile
Gemfile.lock
hk.pkl
Rakefile
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Dotfiles

Set up a fresh host with one command for development in the way I like it.

This is intended exclusively for my personal use, though I encourage you to steal the patterns, tools and concepts within.

## What It Does

Most dotfiles repos just copy files to your home folder. This one does more. It installs apps, sets system settings, and more.

When you run `dotf run` it will:

- Bootstrap Homebrew and mise when needed
- Use `mise bootstrap` to converge tools, system packages, home files, macOS defaults, and LaunchAgents
- Run one-time migrations for existing machines
- Run the remaining imperative Ruby Steps (see `dotf steps`)

## Commands

| Command | What it does |
|---------|--------------|
| `dotf run` | Converge this host to committed tool pins and locks, then apply safe local cleanup. Safe to run many times. |
| `dotf steps` | List every setup step with its class name and description. |
| `dotf help` | Show help |

## Installation

Clone this repo:

```bash
git clone https://github.com/nateberkopec/dotfiles.git ~/.dotfiles
```

Run the setup:

```bash
cd ~/.dotfiles
./bin/dotf run
```

For verbose output that also streams subprocess output:

```bash
DEBUG=true ./bin/dotf run
```

## Philosophies

This is not intended to be run by anyone except me.

Supported platforms:

1. MacOS with sudo
2. MacOS without sudo
3. Ubuntu 22.04

In general, because `mise` is crossplatform, if we can do it with `mise`, we should do it with `mise`.

Managed tools are pinned to explicit versions. `dotf run` consumes the committed mise version and multi-platform `mise.lock`; it never selects upgrades. Self-updating Homebrew casks are presence-managed and observed, never downgraded. macOS itself remains independently latest-seeking and is not part of dependency locking.

`dotf run` aggressively overwrites existing user state. This repo is the source of truth.

Config should drive data, Steps should drive behavior.

Generated artifacts should not be edited as sources of truth.

We do not store secrets on the system in plaintext.

As far as OS settings go, I prefer low/no animation and performance.

There is a GTD-style `~/Documents/Inbox`, which several Steps interact with.

I'm constantly using LLM agents in YOLO mode on my system, so basically I've installed the equivalent of a North Korean rootkit that's running all the time and my system needs to not leave lying around any sharp objects or passwords. See .gem/credentials as an example of the mitigations I take as a result.

We don't trust agents, we make sure they do the right thing and lock destructive/bad actions behind human authentication (immutable flags, 1password).

## How It Works

`dotf run` converges the machine in this order:

1. Bootstrap Homebrew and mise.
2. Run `mise bootstrap`.
3. Run pending migrations.
4. Run imperative Ruby Steps.

Mise owns declarative state in `files/home/.config/mise/config.toml`: tools, system packages, home files, macOS defaults, and LaunchAgents. Ruby Steps remain for behavior mise cannot express cleanly, such as private Homebrew casks, security protections, and application-specific setup. Steps can depend on other Steps.

### Available Steps

Run `dotf steps` for the current step list, class names, and descriptions. See [lib/dotfiles/steps/](lib/dotfiles/steps/) for the implementations.

### Adding Your Own Steps

See [docs/implementing-steps.md](docs/implementing-steps.md) to learn how.

### Ubuntu 22.04

I'm working on supporting Ubuntu in addition to MacOS. It's in a ~half finished state but should eventually become a full "target" OS.

See [docs/ubuntu-22.04.md](docs/ubuntu-22.04.md) for Ubuntu setup and GUI test container notes.

## Project Layout

```
bin/           CLI tool
lib/dotfiles/  Core code and steps
files/         Config files to sync to home folder
docs/          Docs for contributors
test/          Test suite
```

dotfiles

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

dotfiles

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README