Conversation
- Add ghrb banner image - Add npm/license/node badges - Add 'Try it now' npx one-liner - Feature grid with emoji bullets - Numbered Quick Start flow - Command examples (not tables) - Consolidated global flags to one line - Simplified auth setup section - Collapsed JSON envelope and exit codes Closes #47
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughREADME rewritten: branding and header updated, banner and badges added, installation and quick start flows changed, command reference reorganized into per-command sections, examples refreshed, JSON/exit-code docs condensed, and contributing link text shortened. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 135db4168c
ℹ️ 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".
README.md
Outdated
| #### `contacts` — Manage contacts | ||
| ```bash | ||
| partiful cohosts list <eventId> | ||
| partiful cohosts add <eventId> --user <userId> |
There was a problem hiding this comment.
--user flag in cohosts example
The documented command partiful cohosts add <eventId> --user <userId> does not match the CLI interface: registerCohostsCommands only defines --name and --user-id for cohosts add (see src/commands/cohosts.js). Users following this README example will hit an unknown/invalid option path and fail to add co-hosts.
Useful? React with 👍 / 👎.
README.md
Outdated
| partiful template save <eventId> --name "Weekly Game Night" | ||
| partiful template create <templateName> |
There was a problem hiding this comment.
This section documents two invocations that the CLI does not support: template save has no <eventId> positional argument, and there is no template create subcommand (implemented subcommands are list/show/save/edit/delete in src/commands/templates.js). Copy-pasting these examples will produce command parsing errors instead of usable template workflows.
Useful? React with 👍 / 👎.
README.md
Outdated
| partiful bulk create --file events.json | ||
| partiful bulk update --file updates.json |
There was a problem hiding this comment.
--file options
Both bulk examples are incompatible with current command signatures: bulk create expects a positional <file> argument, while bulk update requires --filter plus update fields (see src/commands/bulk.js). The shown --file usage will fail at runtime, so users cannot run bulk operations as documented.
Useful? React with 👍 / 👎.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 90: The README documents a non-existent subcommand "guests summary
<eventId>" but the command handler only provides "list" and "invite" in the
guests command implementation (see guests.js). Either remove or update the
README entry to reflect the actual subcommands ("list" and "invite"), or
implement the missing "summary" subcommand in the guests command handler (create
a "summary" branch/handler that accepts eventId and returns counts by status).
Update the README or code so both the documentation and the guests command
(list, invite, summary) are consistent.
- Around line 120-145: The README documents a non-existent CLI command group:
update either README.md to remove the `template` section (lines showing
`template list`, `template save <eventId> --name`, `template create
<templateName>`) or implement the missing CLI module `template.js` that
registers the `template` subcommands (`list`, `save`, `create`) with the same
flags and behavior; if implementing, ensure the module exports are wired into
the CLI command registry (where other commands like `bulk`, `schema`, `doctor`
are registered) and add corresponding help text and tests.
- Line 97: The README mentions a non-existent "blasts history" command (and
previously "list") while src/commands/blasts.js only registers the "send"
subcommand; either implement the missing subcommands or remove/update the docs.
Add and register a "history" subcommand handler in src/commands/blasts.js (e.g.,
implement a blastsHistoryHandler function and call
program.command(...).action(blastsHistoryHandler) or equivalent), and optionally
add a "list" subcommand handler if you want to restore that functionality;
ensure the handlers are exported/imported where needed and that command names
and help text match the README.
- Line 34: The README claims a `guests summary` command but the codebase only
implements `guests list` and `guests invite`; either remove the README
references or add the missing command. Fix option A: remove the "view summaries"
note and the documented `partiful guests summary <eventId>` usage from README.md
so docs match the implemented CLI (`guests list`, `guests invite`). Fix option
B: implement the command by adding a new CLI subcommand named `guests summary`
(register the command where other guest commands are registered), add a handler
(e.g., function getGuestSummaries or handleGuestsSummary) that accepts eventId,
retrieves/aggregates the summary data, and wire it into the existing CLI
help/usage output so `partiful guests summary <eventId>` works as documented.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
- guests: summary → invite (matches guests.js) - blasts: remove non-existent history subcommand - cohosts: --user → --name (matches cohosts.js) - template: fix subcommands to list/show/save/edit/delete - bulk: create uses positional <file>, update uses --filter
Verified every command against src/commands/*.js and src/helpers/*.js: - auth: save/refresh/clear → login/status/logout (SMS-based, not manual tokens) - auth setup: removed DevTools token grabbing, replaced with auth login flow - contacts: added [query] argument - posters: added get <posterId> - quick start: clarified eventId comes from step 4
1 participant
Closes #47
Changes:
References: gogcli, paperctl README styles
Before: 265 lines, table-heavy, install says
npm install -g .After: 200 lines, example-driven, install says
npm i -g partiful-cliSummary by CodeRabbit