Skip to content

README.md

Latest commit

 

History

History
84 lines (60 loc) · 2.47 KB

README.md

File metadata and controls

84 lines (60 loc) · 2.47 KB
Raw

config

My dotfiles, app config, and formatter config, synced between host and repo with a single script.

Features

  • Two-way sync between host system and this repository.
  • JSON-based mapping for flexible file organization.
  • Optional host-to-repo filters for removing private or machine-specific content.
  • Dry-run mode for safe previewing.
  • No external dependencies (Python 3 standard library only).

Get Started

Clone the repo and pull your host config into it:

git clone <repo-url> && cd config
./scripts/sync.py            # host -> repo

To push repo config back to the host:

./scripts/sync.py --to-host  # repo -> host

Preview before writing:

./scripts/sync.py --dry-run

Config

mappings.json

An array of objects, each mapping a host path to a repo path:

[
  { "hostPath": "~/.zshrc", "projPath": "app/.zshrc" },
  {
    "hostPath": "~/.ssh/config",
    "projPath": "app/ssh/config",
    "script": "app/ssh/config.sh"
  }
]
  • hostPath: absolute or ~-prefixed path on the host.
  • projPath: path relative to the project root.
  • script: optional path relative to the project root. During host-to-repo sync, the script reads the host config from stdin and writes the repo config to stdout. Repo-to-host sync ignores the script.

sync.py flags

Flag Description
--to-host Reverse direction: copy from repo to host.
--dry-run Preview actions without writing files.
--map FILE Use a different mapping file (default: mappings.json).
--project-root DIR Set the base directory for repo paths (default: current directory).
--verbose Print each copy action.

Adding new files

  1. Place the config file under app/ (or another fitting directory).
  2. Add an entry to mappings.json.
  3. Run ./scripts/sync.py or ./scripts/sync.py --to-host as needed.

Repository Layout

  • app/: application config (shell, editor, input method, SSH, etc.).
  • formatters/: formatter config (clang-format, prettier, ruff).
  • scripts/sync.py: the sync script.
  • mappings.json: default host-to-repo path mapping.

License

Copyright (c) 2025 Yulong Ming i@myl7.org

MIT License