docs: refresh README for AI agents and point to manifest-driven dot/ CLI#13
Open
zhuochun wants to merge 1 commit into
Open
docs: refresh README for AI agents and point to manifest-driven dot/ CLI#13zhuochun wants to merge 1 commit into
dot/ CLI#13zhuochun wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
dot/CLI as the primary setup path.--applyrequirements for restores and local restores.Description
README.mdto add anAI Agent Quick Startwith repository rules (clone path expectations, secrets policy, macOS enforcement, and preferred entrypoints).dot/dotanddot/local, documented manifest-driven behavior, dry-run defaults, conflict policies, and rollback snapshot locations.dot/dot setup, and to include explicit commands for common post-setup steps (Zsh, oh-my-zsh, TPM, Neovim plugin install, GUI app permissions).scripts/*as non-primary helpers and updated other topical sections (Tmux, Karabiner, Espanso, Rime, Windows AutoHotkey, Vim/Neovim, custom scripts, fonts, themes, Atom note).Testing
bash -n dot/dot dot/local dot/lib/common.sh dot/lib/symlink.sh(passed)../dot/local backup --dry-run --verboseto verify local backup dry-run behaviour (passed, produced dry-run logs)../dot/dot setup --dry-run --verboseto verify setup flow, which signalled the expected macOS-only guard in this non-macOS container (noted as environment limitation).zsh -n zshrc zshenvbutzshis not installed in the test container (noted as environment limitation).Codex Task