Skip to content

docs: reposition README as Kimi Code harness extension - #64

Merged
Leechael merged 1 commit into
mainfrom
docs/clarify-optional-role
Jul 25, 2026
Merged

docs: reposition README as Kimi Code harness extension#64
Leechael merged 1 commit into
mainfrom
docs/clarify-optional-role

Conversation

@Leechael

@Leechael Leechael commented Jul 25, 2026

Copy link
Copy Markdown
Owner

Closes #60

Summary

Pi v0.82.0 now ships a built-in kimi-coding provider that covers the LLM layer (K3, adaptive thinking, generated model catalog, native OAuth sign-in). This PR repositions the extension as a harness extension that brings the rest of the Kimi Code surface into Pi, rather than a model provider replacement.

Changes

  • README.md: Complete rewrite of positioning and tone
    • Lead with "Kimi Code harness extension for Pi" instead of "Optional extension"
    • Remove defensive "not a replacement" phrasing
    • Replace Sign in with Authentication section explaining credential sync/reuse mechanism
    • Simplify feature list to short, punchy bullets
    • Mark Models section as legacy provider registration
    • Merge and shorten Notes and Troubleshooting
    • Remove Credits section (multiple contributors now)
  • package.json: Update description to match new positioning

Tone

Confident but not over-marketing. States what the extension does and lets the value speak for itself.

Verification

  • npm run format:check passes
  • npm run lint passes
  • Pre-commit hooks pass

Summary by cubic

Repositioned the docs to present this package as a Kimi Code harness extension for Pi, aligned with Pi v0.82.0’s built-in kimi-coding provider. Clarifies that the extension handles shared kimi-code login state, Files API uploads, and Kimi-native tools, with legacy model registration kept for compatibility.

  • Refactors
    • Rewrite README to lead with “Kimi Code harness extension for Pi” and remove defensive phrasing.
    • Replace “Sign in” with “Authentication” explaining credential sync/reuse.
    • Simplify feature bullets; mark Models as legacy provider registration.
    • Merge/shorten Notes and Troubleshooting; remove Credits.
    • Update package.json description to match new positioning.

Written for commit 510553a. Summary will update on new commits.

Review in cubic

Pi v0.82.0 now ships a built-in kimi-coding provider that covers the LLM layer, including K3, adaptive thinking, generated model catalog, and native OAuth sign-in. This makes the extension's original role as a model provider redundant for new users.

Rather than deprecating the package, this commit repositions it as a harness extension that brings the rest of the Kimi Code surface into Pi:

- Shared login state with the official kimi-code CLI (OAuth token sync)
- Kimi Files API uploads for large inline images (ms:// references)
- Kimi-native tools: moonshot_search, moonshot_fetch, kimi_datasource
- Tool schema dedup to stay under Moonshot's 15 KB limit
- Programmatic KimiCode() factory for custom Pi builds

Key changes:
- Rewrite opening to lead with 'Kimi Code harness extension for Pi' instead of 'Optional extension'
- Remove defensive 'not a replacement' phrasing
- Replace Sign in section with Authentication section that explains credential sync/reuse mechanism rather than repeating Pi's native login flow
- Simplify What this package adds to short, punchy bullets
- Mark Models section as legacy provider registration for backward compatibility
- Merge and shorten Notes and Troubleshooting sections
- Remove Credits section (project now has multiple contributors)
- Update package.json description to match new positioning

The tone aims for confident but not over-marketing: we state what the extension does and let the value speak for itself.
@github-actions

Copy link
Copy Markdown
Contributor

CI summary

  • Test coverage: Lines 91.73, branches 80.85, functions 90.59
  • Package size: Packed 55 KB, unpacked 200 KB, files 18
Check Result
Tests passed
Type check success
Lint success
Format success

@cubic-dev-ai cubic-dev-ai 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.

No issues found across 2 files

Re-trigger cubic

@Leechael
Leechael merged commit 5bcdf3c into main Jul 25, 2026
4 checks passed
@Leechael
Leechael deleted the docs/clarify-optional-role branch July 25, 2026 13:18
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.

Deprecate plugin now that Pi supports Kimi Code sign-in

1 participant