Skip to content

Expand CLI reference and group it like the MCP docs#397

Merged
jarugupj merged 4 commits into
mainfrom
hypeship/cli-reference-coverage
Jun 4, 2026
Merged

Expand CLI reference and group it like the MCP docs#397
jarugupj merged 4 commits into
mainfrom
hypeship/cli-reference-coverage

Conversation

@jarugupj
Copy link
Copy Markdown
Contributor

@jarugupj jarugupj commented Jun 3, 2026

Summary

Expands and reorganizes the CLI reference so it reflects the actual command surface (pinned to CLI v0.19.3). Complements #396 (managed auth page) — this PR covers the commands that page doesn't.

What changed

  • New per-command pages: proxies, browser-pools, profiles — previously buried as H2 sections inside the long browsers page, now their own pages.
  • Un-buried those three sections out of reference/cli/browsers.mdx.
  • Nav restructure: the CLI tab now uses groups (Getting Started + Commands) mirroring the MCP tab, instead of a flat page list.
  • Bug fix: Homebrew install snippet corrected from the deprecated onkernel/tap to kernel/tap/kernel (the CLI itself rejects the old tap on upgrade).
  • Refresh: create template list synced to v0.19.3 (adds claude-agent-sdk, tzafon, yutori; fixes gemini-computer-use language tags and stale descriptions).

Relationship to #396

Merged main and deferred to the already-merged pages rather than duplicate them:

  • kernel auth connections, kernel credentials, kernel credential-providers → covered by managed-auth.mdx (Add managed auth CLI reference page #396).
  • kernel status, kernel upgrade → covered by the Utility Commands section in cli.mdx.

These were dropped from this branch to avoid duplication.

Validation

  • docs.json valid JSON; all 13 CLI nav pages resolve.
  • CI green: Mintlify build + broken-links check both pass.
  • browsers telemetry (a browsers subcommand) is intentionally left for a later browsers-page pass.

Note

Low Risk
Documentation-only changes with no runtime or API behavior impact.

Overview
Reorganizes the CLI docs tab to match the MCP layout (Getting Started + Commands) and adds dedicated reference pages for browser pools, profiles, and proxies, pulling those sections out of the long browsers page so each command family is easier to find.

The new pages document CLI v0.19.3 behavior (extra pool/profile/proxy flags, kernel proxies check, profile list pagination, and updated create templates such as claude-agent-sdk, tzafon, and yutori). The CLI overview gains cards linking to the new pages, and the Homebrew install line is corrected to kernel/tap/kernel instead of the deprecated onkernel/tap.

Reviewed by Cursor Bugbot for commit dfcdd21. Bugbot is set up for automated code reviews on this repo. Configure here.

Adds dedicated reference pages for commands that were undocumented or
buried inside the browsers page, and regroups the CLI tab to mirror the
MCP tab (Getting Started + Commands).

- New pages: proxies, browser-pools, profiles, auth-connections, status, upgrade
- Move proxies/browser-pools/profiles out of the browsers page into their own pages
- Fix the Homebrew install command to use the current tap (kernel/tap/kernel)
- Refresh the create template list to match the latest CLI

Command surface and flags pinned to CLI v0.19.3.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Jun 3, 2026, 3:21 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Risk assessment: Very Low

I reviewed the actual diff and found it limited to Mintlify docs/navigation changes: docs.json CLI grouping plus .mdx CLI reference additions/reorganization under reference/cli. There are no executable code changes, migrations, infrastructure changes, auth/permission logic changes, or prompt/instruction files. I also found no CODEOWNERS file and no existing approvals on the PR at review time.

Validation performed: python3 -m json.tool docs.json passes, so the updated Mintlify config is valid JSON.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Documents the kernel credentials and kernel credential-providers commands
on a combined Credentials page, cross-linked to the managed auth and
1Password feature docs. Restores the credential-provider flags on the
auth connections page.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Risk assessment: Very Low

I reviewed the actual diff for this synchronize update. The changes are limited to Mintlify documentation and navigation: docs.json groups the CLI reference pages, reference/cli/browsers.mdx has CLI sections split out, and new reference/cli/*.mdx pages document CLI commands. I found no executable code changes, infrastructure changes, schema migrations, auth/permission enforcement changes, or prompt/model instruction files.

No CODEOWNERS file is present in the repository. The PR already has an approval, so I’m not submitting another approval; the updated diff does not increase the risk level, so there’s no reason to revoke approval.

Validation performed: python3 -m json.tool docs.json and git diff --check 7bc248869333c8126b13d7bc47677ae9412bccd6...60dda9e593efd053f80f1d51f652642575477cf7 both passed.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Reconciles with #396 (managed auth CLI page) and the cli.mdx utility
commands section now on main. Drops the now-duplicate auth-connections,
credentials, status, and upgrade pages; keeps the unique additions
(proxies, browser-pools, profiles), the brew tap fix, the create
template refresh, the browsers-page trim, and the grouped CLI nav.
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Risk assessment: Very Low

I reviewed the current diff at dfcdd21934d19766ffe4c7423667ab70345d14f3 against the PR base. The changes are limited to Mintlify docs/navigation for the CLI reference: docs.json groups CLI pages, reference/cli.mdx and reference/cli/create.mdx update CLI reference copy/cards, and the new or reorganized reference/cli/*.mdx pages document CLI commands. I found no executable code changes, infrastructure changes, schema or data migrations, auth/permission logic changes, or prompt/model instruction changes.

The PR is already approved, so I’m not submitting another approval. The synchronize update does not increase risk, so there’s no approval to revoke. I also found no CODEOWNERS file in the repository.

Validation performed: git show dfcdd21934d19766ffe4c7423667ab70345d14f3:docs.json | python3 -m json.tool >/dev/null and git diff --check a33ae0f9d6167357e874678f3037d7451031fb91...dfcdd21934d19766ffe4c7423667ab70345d14f3 both passed.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@jarugupj jarugupj marked this pull request as ready for review June 3, 2026 21:37
@firetiger-agent
Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

PRs in the kernel, infra, hypeman, and hypeship repos. kernel is a ~mono repo with many logical services underneath, ensure to focus on the implicated service for the PR

Reason: This PR only modifies documentation (CLI reference pages and navigation), which falls outside the operator's filter focusing on code changes in kernel, infra, hypeman, and hypeship repos.

To monitor this PR anyway, reply with @firetiger monitor this.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Risk assessment: Very Low

I reviewed the actual diff for the current PR state. The changes are limited to Mintlify documentation/navigation: docs.json reorganizes the CLI tab into groups, reference/cli.mdx updates CLI reference cards/copy, reference/cli/browsers.mdx has sections split out, and new reference/cli/*.mdx pages document CLI commands for browser pools, profiles, and proxies.

I found no executable code changes, infrastructure changes, schema or data migrations, auth/permission logic changes, or model prompt/instruction changes. There’s also no CODEOWNERS file in the repository. The PR is already approved, so I’m not submitting another approval; the current diff does not increase risk, so there’s no approval to revoke.

Validation performed: git diff --check a33ae0f9d6167357e874678f3037d7451031fb91...dfcdd21934d19766ffe4c7423667ab70345d14f3 and git show dfcdd21934d19766ffe4c7423667ab70345d14f3:docs.json | python3 -m json.tool >/dev/null both passed.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@dprevoznik dprevoznik self-requested a review June 4, 2026 14:16
Copy link
Copy Markdown
Contributor

@dprevoznik dprevoznik left a comment

Choose a reason for hiding this comment

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

LGTM

@jarugupj jarugupj merged commit ee56713 into main Jun 4, 2026
4 checks passed
@jarugupj jarugupj deleted the hypeship/cli-reference-coverage branch June 4, 2026 14:18
jarugupj added a commit that referenced this pull request Jun 4, 2026
* Back-fill missing CLI subcommands in the reference

Documents subcommands and flags that exist in CLI v0.19.3 but were
missing from the reference: deploy github/get/delete, app delete, the
invoke subcommands (get/history/update/browsers/delete-browsers) and
flags (--payload-file/--async-timeout/--since), logs --invocation,
browsers curl/update/telemetry, and mcp server.

Follow-up to #397.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* Trim mcp server description to match CLI help

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
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