Repository navigation
docs: align README and CLI docs with skillx-sh 0.8.0 - #173
Conversation
The README quick start still showed commands the CLI no longer has (`config set SKILLX_API_KEY`, `report --outcome`) and a skill slug that does not exist. List the 0.8.0 command groups, mark `skillx add` as unreleased, bump the CLI reference version, and state that the personal kits API flag is off unless set and on at skillx.sh. Refs #171 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FL32ryWBPFR3jE31snwKmu
clark-cant
left a comment
There was a problem hiding this comment.
Reviewed: docs-only alignment of README + CLI docs to skillx-sh 0.8.0
Summary: Replaces the ~0.4.0-era README examples (config set, report --outcome, the non-existent skillx-search slug) with commands that exist in the released CLI, adds the three missing docs to the README index, bumps docs/cli-reference.md to 0.8.0, and records that production sets SKILLX_PERSONAL_KITS_API=1. Four docs files, +42/-29, no code.
Risk level: Low — documentation only, no runtime surface.
Mandatory gates
- Duplicate / prior implementation: clear. This is the only open PR touching these files;
gh pr list --state all --search "README 0.8.0"returns only #173, and issue #171 has no competing fix. - Project standards: docs found (
docs/code-standards.md); the change follows the existing docs conventions (relative links, table layout in the documentation index). - Strategic necessity: clear value. The README is the first page every new user and every agent reads, and it was advertising three commands that no longer exist plus one slug that never did.
What I checked, at tag skillx-sh-v0.8.0
- Registered commands in
packages/cli/src/index.tsat the tag match the README list one for one:search,find,use,inspect,check,install,update,uninstall,list,sync,mcp,library,kit,validate,pack,publish,promote,release,import,report,config. add.tsis absent from the tag and present onmain, so "skillx add <source>is onmainand ships after 0.8.0" is exactly right.packages/cli/package.jsonat the tag is 0.8.0 withengines.node >=22, matching the new header line.reportsignature is<slug> <outcome>with-d, --duration <ms>(commands/report.ts), soskillx report find-skills success --duration 1234is correct; the removed--outcomeflag is genuinely gone.checkexits 4 unless the answer is actionable, andisCompatibilityActionablereturns true only fordeclaredandverified(packages/contracts/src/compatibility/catalog.ts:126), which is what the README comment claims.install --runtime(defaultclaude-code),sync --locked(required option),config set-key|set-url|show,library listwith--kind/--query/--limit/--cursor, andimport --dry-runall exist with those names.publish owner/reporeally is the deprecated alias:commands/publish.tsprintsIMPORT_DEPRECATIONand forwards torunImport, so the codebase-summary wording is accurate.- The personal-kits claim is backed:
apps/web/wrangler.jsonc:74setsSKILLX_PERSONAL_KITS_APIto"1", so "on at skillx.sh" is factual rather than aspirational. docs/cli-reference.mdalready documentedskillx addbefore this PR; bumping the header to 0.8.0 with the "not yet released" note keeps the reference and the tag honest rather than deleting the section.
Findings
Critical: none.
Important: none.
Suggestion
README.mdAPI block still documents an incomplete/api/reportbody. The new CLI line isskillx report find-skills success, but the endpoint list further down still readsPOST /api/report { outcome, duration_ms }.skill_slugis required by the route (apps/web/app/routes/api.usage-report.ts:35-38returnsskill_slug is required), so the block now contradicts the example this PR just fixed. One-line change:{ skill_slug, outcome, duration_ms? }.docs/codebase-summary.mdLOC column is now half empty, half stale. Three rows became-while the neighbours keep counts that were never re-measured —commands/report.tsis 80 lines atc95ab77, not the 90 shown next to it. Either fill the real counts at this head or drop the column; mixing-with stale numbers reads as less accurate than either.- Minor precision on the AgentKit pointer. The description says the personal-kit contract status line "is fixed in bestagentkits/agentkit#2956". #2956 is the open issue; the actual change is open PR bestagentkits/agentkit#2958 (
docs/specs/personal-kit-contract.md, +4/-2), still unmerged. Worth wording as "tracked in #2956, open PR #2958" so nobody assumes the spec is already corrected.
Verdict
Comment — the documentation is now correct against the released CLI, there is nothing blocking, and the three suggestions are one-line edits the author can take or leave. CI web-contracts-cli is green on a16f25d and the PR is CLEAN/MERGEABLE. No approval recorded here and no merge attempted: this is an owner merge under the repo's one-approval convention, same as #169/#170.
Posted by the github-maintain skill at 2026-11-02T10:05:00Z
Closes #171
Changes
skillx-sh0.8.0 commands. Removedconfig set SKILLX_API_KEYandreport --outcome, which no longer exist, and the non-existentskillx-searchslug.skillx addis marked as onmainand unreleased.cli-reference.md,api-reference.mdandpersonal-kits-api.md.docs/cli-reference.mdversion 0.7.1 → 0.8.0.docs/codebase-summary.mdCLI usage usesimport,config set-keyandreport <slug> <outcome>.docs/personal-kits-api.mdstates that production setsSKILLX_PERSONAL_KITS_API=1.personal-kit-contract.md, lives in AgentKit. Its status line is fixed in bestagentkits/agentkit#2956.Evidence
npm view skillx-shlatest is 0.8.0. Tagskillx-sh-v0.8.0has noadd.ts, while feat(cli): add skillx add to install skills from GitHub, git URLs or local paths #120 and feat(cli): lock, update and sync skills from skillx add; project scope, several runtimes, commit refs #168 landed after it.npx skillx-sh@0.8.0with a temporary HOME:--versionprinted 0.8.0.search,use find-skills,inspect find-skillsandcheck … --target claude-coderan;checkexited 4 because no runtime compatibility is declared, which is what the comment says.install,report,config,importandusehelp confirmed the flags.GET https://skillx.sh/api/v1/kits/@nobody/nokitreturnedauth.required, notkit.api_disabled, so the flag is on in production.apply, a stale line count, andusetakes one argument), and all three are fixed.Docs-only change, no code.
Generated by Claude Code