Repository navigation
docs: sync README, skill, guide and help text with the CLI (v2.15.2) - #242
Merged
Merged
Conversation
Bring every doc surface in line with what the CLI does today: README, skills/one (SKILL.md, flows, relay, scoping references), `one guide` content, and --help / command descriptions. Text only; no behaviour changes. - one init no longer installs an MCP server - Node requirement is 22.23.4+, 24.22.1+ or 26.12.1+ - relay: 100+ source platforms, --confirm-write on writing actions - sync init without --config replaces a profile; sync run needs --embed - semantic memory search needs pgvector as well as an OpenAI key - flows: valid while example, real --mock / --dry-run behaviour, no Ctrl+C pause, fallback, resume flags Version bumped to 2.15.2 so installed skill files refresh. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Nov 20, 2026
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.
Why
The docs had drifted from the CLI. Several examples were broken outright: an agent following them would be refused (
relay activatewithout--confirm-write), fail validation (thewhileflow example), or lose data (the skill told agents to "patch" a profile withsync init, which replaces it without--config).What changed
Text only. No behaviour changes: every
src/edit is a help string, a command description or a printed hint.one initno longer installs an MCP server. New sections forone whoami,--agentmode,one onboard,flow scaffold,config path/config reset. Memory and sync corrections below.skills/one/SKILL.md): the--confirm-writerule across actions, flows and relay;connection listcaps at 20 in agent mode;gmail/gmailThreads(wasgmail/threads); Connect needs@withone/connect0.20.0+.references/flows.md: awhileexample that passes the validator ($['steps'].<id>self-reference), what--mockand--dry-runreally do (--mockruns file writes for real), no Ctrl+C pause, howfallbackbehaves, which flagsresumeneeds again.references/relay.md: 100+ source platforms (was 5),--confirm-write, don't pass--webhook-secretwith--create-webhook.references/scoping.md: an agent can set up a project config itself withone --agent init --auth browser --project; access settings don't follow the usual resolution order.one guidecontent: the same corrections for flows, memory, sync and relay, plus the real topic list.--helptext:mem search --deepremoved; the access-count reset marked as a no-op;sync delete/sync removesay they only touch the SQLite mirror;sync approveandrelay get|update|deleteadded;cache cleardescribes what it clears.sync initwithout--configreplaces an existing profile;sync runneeds--embed, because a profile'smemory.embedisn't applied.CLAUDE.md: the doc checklist points atsrc/cli.tsfor help text.Not in this PR
The audit turned up code bugs where the docs promised behaviour the code doesn't have. These docs now describe what the code does; the code is unchanged. Some of them:
sync runignores a profile'smemory.embedunless--embedis passed.mem search --deepand--no-trackdo nothing.flow execute --mockruns file-write steps for real.fallbacknever runs the fallback step.sync initwithout--configsilently overwrites an existing profile.one --agent logoutdeletes both the project and global config without confirming.The companion website PR updates the CLI, getting-started and Relay pages in
withoneai/landing.Testing
npm run typecheckpasses.main(better-sqlite3built for a different Node on this machine).one guide flowspassflow validate.one relay platformsand the CLI code. Server-side relay behaviour (template rendering, filter matching, a wrong webhook secret) isn't in this repo and wasn't verified.🤖 Generated with Claude Code