docs: simplify README — npx-first, drop verbose Codex manual setup - #15
Merged
Conversation
* Lead the quick start with `npx agentmind-cli claude` / `npx agentmind-cli codex` — zero install, zero config. Global install becomes a one-line footnote. * Demote bare `agentmind-cli` (the v0.2.1 implicit default). It still works in the binary, but the docs now always show an explicit subcommand. Less guessing for new readers. * Drop the technical Upstream/endpoint table from the quick-start area — duplicated the later Supported-agents section and added noise. Kept one status table further down. * Manual setup: collapsed the Codex section from ~50 lines of "two defaults work against us" lecture down to the config snippet + one paragraph explaining the two required flags. The launcher handles all of this transparently so the long version was dead weight for 95% of readers. * Small consistency edits: \"reuse\" instead of \"work with\" for existing logins, trimmed the migration parenthetical in the storage section, and removed the \"launches Claude by default\" caption from the file tree. No behaviour change, doc-only. \`pnpm typecheck\` is clean.
Merged
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.
Summary
User feedback: README still over-explains things the launcher now
handles for you. This pass slims it down.
`npx agentmind-cli codex`. Global install demoted to a one-line
footnote.
It still works (v0.2.1 added it as an implicit Claude shortcut), but
every doc example now spells out the subcommand. Less guessing.
against us" lecture down to the config snippet + one paragraph on
the two required flags. `agentmind-cli codex` handles all the
quirks transparently — manual setup is now a small escape hatch for
the `--no-agent` flow, not a primary path.
start (duplicated the Supported-agents section below it).
trimmed the migration parenthetical in the storage section, removed
the "launches Claude by default" caption from the file tree.
126 lines → 89 lines (-37).
Scope
Doc-only. No code changes. `pnpm typecheck` is clean.