Skip to content

Feat/help command sync - #564

Open
kr3shna wants to merge 3 commits into
getkimchi:masterfrom
kr3shna:feat/help-command-sync
Open

Feat/help command sync#564
kr3shna wants to merge 3 commits into
getkimchi:masterfrom
kr3shna:feat/help-command-sync

Conversation

@kr3shna

@kr3shna kr3shna commented Jun 11, 2026

Copy link
Copy Markdown

Description

The TUI /help overlay only listed ~17 slash commands while users can run 40+ (upstream pi commands plus Kimchi extensions). Hidden commands included session tools (/name, /session, /resume, /import, /export), auth (/login, /logout), and Kimchi-only tools (/teleport, /clear, /mcp-auth, etc.).

This PR restructures HELP_ROWS in src/extensions/help.ts into topic sections (Session, Model, Kimchi, MCP & resources, Teleport, Settings & auth, Utility), adds upstream commands with curated descriptions, and documents /exit (not upstream /quit). Adds src/extensions/help.test.ts with regression checks so internal commands like /cc-tools stay out of help.

Related to #554 (same discoverability theme; broader than rename-only). Supersedes the /name-only slice in #561 if that PR is still open.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Test plan

  • pnpm run check
  • KIMCHI_PROXY_HELPER=$(pwd)/bin/proxy-helper pnpm run test src/extensions/help.test.ts
  • Manual: pnpm run dev/help → scroll all sections (verified at 80×24 via overlay scroll simulation + live PTY)
  • Confirm /exit is listed (not /quit) — verified in help.test.ts and overlay content

kr3shna and others added 2 commits June 11, 2026 09:48
Users could run 40+ commands but /help only listed ~17; group entries by topic and add regression tests so discoverability stays in sync.

Co-authored-by: Cursor <cursoragent@cursor.com>
@readme-ai-writer

readme-ai-writer Bot commented Jun 11, 2026

Copy link
Copy Markdown

📚 No documentation changes were needed for this PR (Job ID: 6a2a3d8d18a1a556794be491).

@kimchi-review

kimchi-review Bot commented Jun 11, 2026

Copy link
Copy Markdown

Kimchi Code Review

Property Value
Commit 2fe955d
Author @kr3shna
Files changed 0
Review status Completed
Comments 0
Duration 174s

Summary

📊 Review Score: 95/100 (overall code quality — 0 lowest, 100 highest)
⏱️ Estimated effort to review: 1/5 (1 = trivial, 5 = very complex)

🧪 Tests: yes — Thorough test coverage added in src/extensions/help.test.ts. Tests validate that high-value and Kimchi-specific commands are present, upstream/internal commands are excluded, the help uses subsection headings, and the getHelpCommandKeys utility behaves correctly.

No significant issues found. LGTM! 🎉

What to expect

Kimchi will analyze the changes in this pull request and post:

  • A summary of the overall changes
  • Inline comments on specific lines with findings categorized by issue type

The review typically completes within a few minutes. This comment will be updated once the review is ready.

Interact with Kimchi
  • @getkimchi review — re-trigger a full review on the latest commit
  • @getkimchi summary — regenerate the PR summary
  • @getkimchi ignore — skip this PR (no review will be posted)
  • Reply to any inline comment to ask follow-up questions or request clarification
Configuration

Reviews are configured by your organization admin.
Review instructions, excluded directories, and severity thresholds can be adjusted per repository in the Kimchi dashboard.


Powered by Kimchi — AI-powered code review by CAST AI

@kr3shna

kr3shna commented Jun 11, 2026

Copy link
Copy Markdown
Author

@getkimchi review

@kimchi-review

kimchi-review Bot commented Jun 11, 2026

Copy link
Copy Markdown

A review is already in progress for commit 2fe955d.

@kimchi-review kimchi-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📊 Review Score: 95/100 (overall code quality — 0 lowest, 100 highest)
⏱️ Estimated effort to review: 1/5 (1 = trivial, 5 = very complex)

🧪 Tests: yes — Thorough test coverage added in src/extensions/help.test.ts. Tests validate that high-value and Kimchi-specific commands are present, upstream/internal commands are excluded, the help uses subsection headings, and the getHelpCommandKeys utility behaves correctly.

No significant issues found. LGTM! 🎉

@kr3shna

kr3shna commented Jun 11, 2026

Copy link
Copy Markdown
Author

Thanks for taking a look when you have time. This expands /help to document the full slash command surface (upstream + Kimchi commands), with regression tests in help.test.ts.

Related to #554 discoverability. Supersedes the /name-only help slice in #561 if maintainers prefer one PR for help changes.

Happy to add a /name tip in /tips or before/after screenshots if that would help review.

@castabar

Copy link
Copy Markdown
Contributor

Hello there @kr3shna
Thank you for doing this!

Could you also provide some screenshots of the before / after?

Resolve /help conflict by keeping the sectioned layout and adding
upstream /todos under Kimchi. Extend help.test.ts to cover /todos.
@kr3shna

kr3shna commented Jun 19, 2026

Copy link
Copy Markdown
Author

Before / after

Before (upstream master) — single flat "Slash Commands" list:
help-before

After — sectioned /help (Session, Model, Kimchi, Teleport, …):
help-after-session

help-after-teleport

@kr3shna

kr3shna commented Jun 19, 2026

Copy link
Copy Markdown
Author

Hello there @kr3shna Thank you for doing this!

Could you also provide some screenshots of the before / after?
@castabar Added before/after screenshots to the PR description.

  • Before: flat "Slash Commands" on upstream master (~17 visible, "13 more")
  • After: sectioned layout starting with Session (/name, /resume, …), full command surface documented

Let me know if you'd like additional crops or scroll positions.

@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown

This PR has been marked as stale because it has not had recent activity. It will be closed tomorrow if no further activity occurs.

@github-actions github-actions Bot added the stale No recent activity label Aug 1, 2026
@kr3shna

kr3shna commented Aug 1, 2026

Copy link
Copy Markdown
Author

@castabar please can review it once

@github-actions github-actions Bot removed the stale No recent activity label Aug 2, 2026
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.

2 participants