Skip to content

fix(codex): correct session command in README#905

Open
Cheese-Yu wants to merge 1 commit intoryoppippi:mainfrom
Cheese-Yu:codex/fix-documentation-error-for-sessions
Open

fix(codex): correct session command in README#905
Cheese-Yu wants to merge 1 commit intoryoppippi:mainfrom
Cheese-Yu:codex/fix-documentation-error-for-sessions

Conversation

@Cheese-Yu
Copy link

@Cheese-Yu Cheese-Yu commented Mar 25, 2026

Motivation

  • Fix an incorrect example in the Codex README where the CLI subcommand was documented as npx @ccusage/codex@latest sessions instead of the actual npx @ccusage/codex@latest session.

Description

  • Replace the incorrect command in apps/codex/README.md, changing npx @ccusage/codex@latest sessions to npx @ccusage/codex@latest session.

Testing

  • Ran pnpm run format, which completed successfully.
  • Ran pnpm typecheck, which failed due to existing TypeScript typing issues in the baseline unrelated to this README change.
  • Ran pnpm run test, which showed baseline test failures in apps/ccusage caused by environment-dependent pricing and Claude data-dir issues and are unrelated to this documentation fix.

Summary by CodeRabbit

  • Documentation
    • Corrected the Codex CLI command documentation for session-level detailed reports to reflect the accurate command syntax.

@coderabbitai
Copy link

coderabbitai bot commented Mar 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1584c8d1-7de1-457d-b428-4d8f05851a15

📥 Commits

Reviewing files that changed from the base of the PR and between d3cb6df and 207152f.

📒 Files selected for processing (1)
  • apps/codex/README.md

📝 Walkthrough

Walkthrough

Updated the CLI documentation in the Codex README to correct the subcommand name from sessions to session, reflecting the accurate command syntax for retrieving session-level detailed reports.

Changes

Cohort / File(s) Summary
Documentation Update
apps/codex/README.md
Corrected CLI command example from plural sessions subcommand to singular session subcommand in documented usage instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A typo hopped away, the command now rings true,
From sessions plural to session—just one will do,
The README gleams bright, no longer misleads,
Clear paths for the users to follow with speed!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix(codex): correct session command in README' directly and accurately summarizes the main change: correcting the session command documentation in the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant