Skip to content

[codex] refresh README and AGENTS docs#262

Merged
AnnatarHe merged 1 commit intomainfrom
codex/update-readme-and-agents
Apr 6, 2026
Merged

[codex] refresh README and AGENTS docs#262
AnnatarHe merged 1 commit intomainfrom
codex/update-readme-and-agents

Conversation

@AnnatarHe
Copy link
Copy Markdown
Contributor

@AnnatarHe AnnatarHe commented Apr 6, 2026

Summary

  • refresh the top-level README to match the current ShellTime CLI surface
  • update AGENTS.md with current repo identity, workflow, and documentation-maintenance guidance
  • document the intentional ShellTime branding vs github.com/malamtime/cli module-path mismatch

Why

The top-level docs were stale and no longer matched the current command set, setup flow, or contributor expectations.

Impact

Users get an accurate getting-started guide, and contributors/agents get clearer repo guidance for future doc and command updates.

Validation

  • reviewed README.md against the current commands declared under commands/
  • checked config-path wording against model/config.go
  • tests not run because this is a documentation-only change

Open with Devin

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
unittests 39.32% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AnnatarHe AnnatarHe marked this pull request as ready for review April 6, 2026 15:11
@AnnatarHe AnnatarHe merged commit 3fa04f0 into main Apr 6, 2026
3 checks passed
@AnnatarHe AnnatarHe deleted the codex/update-readme-and-agents branch April 6, 2026 15:13
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation in AGENTS.md and README.md to better reflect the ShellTime CLI and daemon's functionality, including new sections on project identity, expanded command references, and updated setup instructions. The guidelines were also updated with more specific development and testing commands. A review comment pointed out that the specified Go version 1.26 is invalid and should be corrected to a stable version like 1.23.

Comment thread AGENTS.md
- `mockery`: regenerate mocks when interfaces change
- `pp g`: regenerate PromptPal-generated artifacts when relevant

Use Go 1.26, as declared in `go.mod`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Go 1.26 is not a released version (the current stable version is 1.23). This is likely a typo for the version actually declared in go.mod (e.g., 1.22 or 1.23).

Suggested change
Use Go 1.26, as declared in `go.mod`.
Use Go 1.23, as declared in go.mod.

Copy link
Copy Markdown

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 potential issue.

View 2 additional findings in Devin Review.

Open in Devin Review

Comment thread README.md
| `shelltime q "prompt"` | Alias for `shelltime query` |
| `shelltime cc install` | Install Claude Code OTEL shell configuration |
| `shelltime cc uninstall` | Remove Claude Code OTEL shell configuration |
| `shelltime cc statusline` | Emit statusline JSON for Claude Code |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 README describes cc statusline output as JSON when it actually emits formatted ANSI text

The command table says shelltime cc statusline will "Emit statusline JSON for Claude Code", but the command actually reads JSON from stdin and outputs formatted plain text with ANSI color codes and OSC8 hyperlinks (see commands/cc_statusline.go:108 where fmt.Println(output) prints the result of formatStatuslineOutput, which returns a strings.Join(parts, " | ") of color-formatted segments). The command's own Usage field correctly says "Output statusline for Claude Code (reads JSON from stdin)" at commands/cc_statusline.go:28. A user reading this table entry would expect the command to produce JSON output, which is incorrect.

Suggested change
| `shelltime cc statusline` | Emit statusline JSON for Claude Code |
| `shelltime cc statusline` | Output formatted statusline for Claude Code |
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

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