Skip to main content

A CLI dotfile manager that symlinks files from a dotfiles repo

Project description

Dottie

A small CLI dotfile manager that symlinks files from a dotfiles repository into your home directory (or another target path).

Requirements

  • Python 3.10+

Install

From PyPI:

pip install dottie

The dottie command is registered on your PATH.

Quick start

  1. Point dottie at your dotfiles repository:

    dottie init /path/to/your/dotfiles
    

    On first run without a config file, dottie will prompt for the repo path instead.

  2. Create symlinks from the repo into your target directory (default: your home directory):

    dottie link
    

    Use dottie link --dry-run to preview changes, or dottie link --force to replace conflicting files (originals are backed up).

  3. Inspect state:

    dottie status
    dottie list
    dottie config
    
  4. Remove symlinks that dottie created (dotfiles in the repo are not deleted):

    dottie unlink
    

Configuration

Configuration lives at ~/.config/dottie/config.json. You can set:

  • repo — path to your dotfiles repository
  • target — directory where symlinks are created (default: home)
  • ignore — path segments to skip when collecting files (default includes .git, .gitignore, README.md, LICENSE)

Use dottie config to view the active values.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dottie-0.1.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dottie-0.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file dottie-0.1.0.tar.gz.

File metadata

  • Download URL: dottie-0.1.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for dottie-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6a5f3b9355df3f0e1b986a5460d0ca431b517a36de78efbecbd695fb67a2d5c1
MD5 9ea78d4f8ac6cb809a03f7c9c49b5658
BLAKE2b-256 ddaa5461e7f3d634e9fe9384efcbe9afa441b63b6976b5c0c3ba3433fd5eddb4

See more details on using hashes here.

File details

Details for the file dottie-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dottie-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for dottie-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 839ba581e38307a6304c31fbaa725d8dc3d678ced082030f9e2b3333bfd9eb9f
MD5 dc9d1ab0b9c0187c974f33c414a55dcd
BLAKE2b-256 5d2fe09a4e7a7e3e377bd88610a10f4a791bd697d7fcc3edd08fe6dd1b73b5d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page