[codex] Document event-based aggregation behavior#36
Merged
Conversation
- Add README and README_zh guidance for usage-event dates, timezone filters, session event filtering, and CODEX_HOME sessions. - Extend daily/session help text and tests so CLI help preserves the documented event aggregation semantics. - Mark EBTA-010 done after final validation and review.
There was a problem hiding this comment.
Pull request overview
Documents the CLI’s event-based aggregation semantics (daily bucketing + session filtering), timezone behavior, and Codex session source resolution so README/help text align with the current event-driven stats pipeline.
Changes:
- Update English + Chinese READMEs to describe event-based aggregation, default local timezone /
--timezone(IANA), and$CODEX_HOME/sessionsresolution. - Extend
dailyandsessioncommand long help text to match implemented behavior. - Add help-rendering tests to ensure the new help guidance stays present; mark EBTA-010 as done in the task plan.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/plans/2026-04-16-event-based-token-aggregation-task.md | Marks EBTA-010 as done and logs validation timeline. |
| cmd/daily.go | Adds long help text describing event-date bucketing + timezone + Codex home resolution. |
| cmd/session.go | Adds long help text describing event-date filtering + timezone + Codex home resolution. |
| cmd/help_text_test.go | Adds tests asserting the help text mentions event semantics, timezone, and $CODEX_HOME. |
| README.md | Updates docs for event-based aggregation, timezone semantics, $CODEX_HOME resolution, and dashboard examples. |
| README_zh.md | Chinese doc parity for event semantics, timezone, $CODEX_HOME, and updated daily dashboard examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Explain when daily JSON provider may be empty and providers lists contributors. - Apply the clarification in both English and Chinese READMEs after Copilot review.
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.
Summary
--timezoneIANA names, and Codex$CODEX_HOME/sessionssource resolution in English and Chinese READMEs.dailyandsessionhelp text so CLI help matches the implemented event aggregation semantics.Validation
make fmtmake testmake vetmake buildmake lint(0 issues)./bin/codetok daily --help./bin/codetok session --help./bin/codetok daily --all --kimi-dir "$(pwd)/e2e/testdata/sessions" --claude-dir "$EMPTY_DIR" --codex-dir "$EMPTY_DIR" --cursor-dir "$EMPTY_DIR"