docs(cli): re-add CometChat CLI page (CLI-only re-application of #470) - #522
Open
raj-dubey1 wants to merge 3 commits into
Open
docs(cli): re-add CometChat CLI page (CLI-only re-application of #470)#522raj-dubey1 wants to merge 3 commits into
raj-dubey1 wants to merge 3 commits into
Conversation
PR #470 merged into docs/skills-v5-temp, not main, and the CLI page was later dropped from that branch. This re-applies only the CLI part on top of current main: - cli.mdx: CometChat CLI reference (@cometchat/skills-cli credentials CLI + @cometchat/skills pack CLI), content identical to #470 - docs.json: add "cli" to the hidden Developer Tools group - index.mdx: add the CLI card next to the existing Agent Skills card - agent-skills.mdx: link "run the CLI yourself" to /cli so the page is reachable from where the CLI is mentioned The agent part of #470 (agent-skills page, Developer Tools tab with agent-skills + mcp-server, Agent Skills index card) is already on main. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016PKoDnjiUuSaNFfuKLMJFs
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
- cli.mdx: replace the Scripting and CI example. auth login needs a browser approval and times out on CI runners; use config init with pipeline secrets instead, and warn against --json there (it echoes the Auth Key). - cli.mdx: config init creates/updates the config from --app-id, --region and --auth-key; it isn't an "empty config". - cli.mdx: add is non-interactive (defaults to Claude Code), not a picker. - cli.mdx: the CLI already chmods config.json to 600, gitignores it, and warns when it's tracked; say so instead of asking readers to do it. - cli.mdx: document features --app-id, pass the OpenAI key from an env var, note add connects the Docs MCP (--no-mcp), explain the skills-cli package / `cometchat` command naming, add Angular next step. - agent-skills.mdx: add has no picker and connects the Docs MCP; --global is Claude Code only; list shows the skills the pack ships. - index.mdx: 2-column "More" group so the 4 cards form a 2x2 grid; Agent Skills card mentions Angular. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016PKoDnjiUuSaNFfuKLMJFs
adityagokula2210
previously approved these changes
Sep 11, 2026
…val, uninstall
- cli.mdx: provision run doesn't "pick or create" in general. It uses the
only app, prompts when there are several (entering `n` there creates
one; needs a TTY), and exits when there are none. Without --json it
prints "✓ App <id> (<region>)", not JSON.
- cli.mdx: note that config show (with or without --json), config get
authKey and provision run --json print the Auth Key in clear.
- agent-skills.mdx: Claude Code must approve the cometchat-docs MCP on
first start ("Pending approval" until then).
- agent-skills.mdx: full uninstall list, covering skill folders, the
managed router block in the agent's instruction file, and the
cometchat-docs MCP entry (Claude Code, Cursor, Gemini, Codex only).
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016PKoDnjiUuSaNFfuKLMJFs
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.
Description
CLI-only re-application of #470 on top of current
main.#470 ("Added CLI Docs") merged into
docs/skills-v5-temp, notmain. The CLI page was then removed from that branch (commite6e6422a, which deletedcli.mdxand reverted the relateddocs.json/index.mdxhunks), so/clinever reachedmain. This PR brings back only the CLI part.Applied from #470 (CLI part)
cli.mdx(new): the CometChat CLI reference, covering the@cometchat/skills-clicredentials CLI and the@cometchat/skillspack CLI. It started from Added CLI Docs #470's final version; the review fixes below then corrected it against the published CLI.docs.json: addsclito the hidden Developer Tools group, betweenagent-skillsandmcp-server, the same order as Added CLI Docs #470.index.mdx: adds the CLI card after the existing Agent Skills card.Already present on
main(agent part, not re-added)agent-skills.mdxalready exists onmain, and has been updated since Added CLI Docs #470 to cover the Angular UI Kit v5 pack.Developer Toolsgroup already containsagent-skillsandmcp-server. Added CLI Docs #470's move ofmcp-serverout of the hiddenDocs MCPgroup under Home is also already done onmain.index.mdxalready exists.Small supporting change (not in #470)
agent-skills.mdx: turns "run the CLI yourself" in Connect your credentials into a link to/cli. The Developer Tools tab is hidden, so without this the page would only be reachable from the home-page card.No pages were moved or renamed, so no redirects are needed. There was no existing redirect or page at
/cli.Source check
I checked the CLI claims against the current
cometchat-skillssource (packages/cli/src,bin/cometchat-skills.mjs) and against public npm (@cometchat/skills-cli@3.0.0and@cometchat/skills@5.0.0are bothlatest). The following all match the source:auth meandfeatures list|enable|disable|ai-keyprovision create --name/--region/--industryflags$schemakey written to.cometchat/config.json--jsonbeing unsupported onconfig setandconfig pathpackages/cli/README.mdin that repo is out of date: it omitsfeaturesandauth me, and says all commands accept--json. Where the README and the source disagree, this page follows the source.Verification
docs.jsonis valid JSON, and every navigation page reference resolves to an existing file. That's 3,153 refs with 0 missing, the same asmain.cli.mdx,index.mdxandagent-skills.mdxresolves (/agent-skills,/cli,/mcp-server,/ui-kit/react/integration-react, and the rest).mint broken-linkson the full repo can't finish onmaintoday. It aborts on a pre-existing MDX syntax error insdk/react-native/authentication-overview.mdx(line 16), which this PR doesn't touch, and its output is identical with and without this change. I also ran it against a minimal project containing just the changed pages: they parse cleanly, andcli.mdxhas zero broken links.Review fixes (2b6dcdd)
Checked against the published
@cometchat/skills-cli@3.0.0and@cometchat/skills@5.0.0:auth loginneeds a browser approval and times out (TIMEOUT) on a CI runner, and no command prints a bearer token forCC_TOKEN. The example now writes the config from pipeline secrets withconfig init --app-id --region --auth-key, which needs no login. A warning says not to add--jsonthere, because its output includes the Auth Key. It also says thatprovisionandfeaturesneedauth login.config init: it creates or updates the config from--app-id/--region/--auth-key, rather than creating an empty one.addinstalls for Claude Code unless you pass--ide. Fixed incli.mdxand inagent-skills.mdx(Install section).config.jsonowner-only (chmod 600), adds it to.gitignore, and warns if it's already tracked. The page now says so, and givesgit rm --cachedfor the tracked case.features: documents--app-idand that the commands needauth login, and passes the OpenAI key as"$OPENAI_API_KEY"so it stays out of shell history.addalso connects the Docs MCP, and--no-mcpskips it. Documented on both pages.@cometchat/skills-cliis the credentials tool and provides thecometchatcommand, which the CLI's own messages use.@cometchat/skillsis now labelled "Skills installer".agent-skills.mdx:--globalis Claude Code only, not Kiro or Replit, andlistlists the skills the pack ships, not the installed ones.index.mdx: the "More" group is nowcols={2}, so its 4 cards form a 2×2 grid and the CLI card no longer sits alone on a row. The Agent Skills card now says "React or Angular".Not fixed here (CLI-side):
https://cometchat.com/schemas/config.jsonreturns 404. The page correctly shows what the CLI writes; the CLI needs to publish the schema or drop$schema.Re-verified: all three changed pages parse cleanly in
mint broken-links(minimal project), with no broken links.Second review pass (1915fe5)
provision run: it doesn't generally "pick or create" an app. With one app it uses that app. With several it asks you to pick, and enteringnthere creates a new one; this needs a TTY. With none it exits with an error that points toprovision create. Without--jsonit prints✓ App <id> (<region>), not JSON. Fixed in the Quick start comment, the Provision section and the command table.config show(with or without--json),config get authKeyandprovision run --jsonprint the Auth Key in clear text.agent-skills.mdxnow says to approvecometchat-docson first start; until thenclaude mcp listshows it as Pending approval.addwrites. That's the skill folders, the<!-- cometchat-skills:start/end -->block in the agent's instruction file (AGENTS.md,.windsurfrules,.github/copilot-instructions.md,.clinerules/cometchat.md,GEMINI.md,CONVENTIONS.md), and thecometchat-docsMCP entry. Only Claude Code, Cursor, Gemini and Codex get an MCP entry.Left as is: the pages stay scoped to React and Angular, although the package also ships React Native, iOS, Android, Flutter and calls skills. That's a product decision.
Type of Change
Checklist
🤖 Generated with Claude Code
https://claude.ai/code/session_016PKoDnjiUuSaNFfuKLMJFs