docs: an Install section for Homebrew, npm and npx; Usage uses the installed command - #31
Merged
Merged
Conversation
…stalled command Homebrew was a paragraph inside Usage and every example said `npx create-dotfiles`, so someone who installed with Homebrew had no guidance on running the command, updating or removing it. - New "Install" section after Quickstart: a table comparing Homebrew, npm and npx, then Homebrew in full: tap + trust + install (and the one-command form), how to use `create-dotfiles`, `brew update && brew upgrade` (plain `brew upgrade` checks once a day), uninstall/untap/untrust (untap keeps trust entries), and the Brewfile. npm, with pnpm and Yarn 1 caveats. npx, with when `@latest` matters (an installed copy shadows it). - Usage, Password-protected zip and Restore examples use `create-dotfiles`; Quickstart and the transcripts stay npx-first. Every command was run against the real tap: the trust steps in an isolated trust store, uninstall/untap/untrust by syntax and source, installs as dry runs or into temp prefixes. Closes #30 Claude-Session: https://claude.ai/code/session_01VJAcaQKguGJYY9TjWzGCtV
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
1 participant
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.
Closes #30.
Changes
## Installsection right after Quickstart. It opens with a table comparing Homebrew, npm and npx: the command afterwards, how updates arrive, and what each needs.brew install thilllon/tap/create-dotfiles. Then how to use the installedcreate-dotfiles(interactive,--auto,--dry-run,--encrypt-zip,restore,--help,--version).brew update && brew upgrade create-dotfiles, since plainbrew upgradechecks only once a day (HOMEBREW_AUTO_UPDATE_SECSdefaults to 86400).brew untapkeeps trust entries, sountrustis a separate step.trusted: true.npm i -g. pnpm needspnpm setupand only installs a release once it is a day old (pnpm 11);yarn globalworks on Yarn 1 only.@latestmatters when an installed copy (Homebrew,npm i -g, or the project) would otherwise shadow it.create-dotfiles, with a note to putnpxin front if you haven't installed it. Quickstart and the console transcripts stay npx-first.Verification
Every command in the new sections was run against the real tap without changing this machine's Homebrew state.
XDG_CONFIG_HOME),brew infoandbrew install --dry-run create-dotfilesfail with "untrusted tap" beforebrew trust thilllon/tapand work after it.brew install --dry-run thilllon/tap/create-dotfilestrusts just the formula.brew bundle checkandbrew bundle installtrust the tap.brew upgrade --dry-run.create-dotfilesexample ran against the brew-installed binary with a temp HOME.npm i -gwas checked with a temp--prefix; pnpm, Yarn 1, Yarn 4 and the npx caching behaviour were checked in isolated directories.🤖 Generated with Claude Code
https://claude.ai/code/session_01VJAcaQKguGJYY9TjWzGCtV