Repository navigation
docs: launch README - #19
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KXDWKPCAN5EkLoUwsvtKh3
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c0462cc0dc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| pcs note add task "Add the --json flag to the exporter" | ||
| pcs test --task <task-id> -- npm test # PCS runs it and records the result |
There was a problem hiding this comment.
Create a task before linking test evidence
In this walkthrough, pcs note add task records an original-task note; it does not create a task or provide the ID that pcs test --task requires. As written, the next command cannot link its run to a task. Add a pcs task add step and use that ID, or omit --task.
Useful? React with 👍 / 👎.
|
|
||
| ## Uninstall | ||
|
|
||
| `pcs deinit` removes everything PCS added to a project: the `.pcs` folder, hooks, instruction blocks and the login entry. `pcs connect <app> --remove` removes the MCP entry. |
There was a problem hiding this comment.
Document that deinit requires
--yes
When readers follow this uninstall instruction, plain pcs deinit only displays a removal plan and leaves the project unchanged. The CLI requires pcs deinit --yes to perform the removal, so document that flag to avoid users thinking the uninstall is complete.
Useful? React with 👍 / 👎.
What
New README for launch, replacing the old command dump.
pcs init,pcs connect,agents install,hooks install,doctor.Why
The README is the npm page and the first thing visitors read; it is frozen into the package at publish time, so it lands before the first release.
Checks
Encoding test passes. Commands and flags were checked against
pcs --help.?? Generated with Claude Code
https://claude.ai/code/session_01KXDWKPCAN5EkLoUwsvtKh3