Skip to content

docs: add Klaatu setup guide for OpenCode - #66

Open
shivaylamba wants to merge 1 commit into
mainfrom
docs/opencode-klaatu-guide
Open

docs: add Klaatu setup guide for OpenCode#66
shivaylamba wants to merge 1 commit into
mainfrom
docs/opencode-klaatu-guide

Conversation

@shivaylamba

Copy link
Copy Markdown

Adds a new Guides section to the README and introduces docs/guides with a step-by-step guide for connecting OpenCode directly to Klaatu's OpenAI-compatible Chat Completions API. The guide covers authentication, provider and agent configuration, verification, session selection, and common errors.

Closes #65

Validation:

  • bun run typecheck
  • bun test (445 tests)
  • bun run build
  • bun run bench:selfcheck (33 fixtures)
  • Parsed and validated the embedded opencode.json example
  • Confirmed opencode agent list with OpenCode 1.18.28

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🤖 KlaatAI Review Bot (powered by Klaatu, advisory only — a maintainer makes the real call)

Issue match — Fully addresses issue #65. The PR adds the requested documentation for configuring OpenCode with the Klaatai provider and Klaatu model in docs/guides/configure-klaatu-in-opencode.md and properly surfaces it via a new section in the main README.md.

Test coverage — No test files were modified, which is expected for a pure documentation PR. The PR body notes the embedded opencode.json was manually parsed and validated. Reviewers should confirm if the repo has an existing automated markdown or JSON linting step in CI to catch future typos in these code blocks.

Correctness concerns — No technical risks, as this is purely documentation. The troubleshooting section usefully anticipates the common copy-paste error of including markdown link syntax in the $schema URL. The provider ID klaatai is consistently used across both the opencode auth login steps and the opencode.json configuration block.

Verdict — Ready to merge as-is, assuming the human maintainer confirms the OpenCode 1.18.28 CLI prompts exactly match the documented auth flow.

This is an automated review to help triage faster, not a gate. Nothing here blocks merging.

Copilot AI 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.

🟡 Changes recommended

The new docs introduce avoidable auth/terminology ambiguity (API keys vs browser OAuth; KlaatAI vs Klaatu) that should be clarified to prevent reader confusion.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds end-user documentation for integrating OpenCode with Klaatu by introducing a new Guides section in the README and a new docs/guides documentation area, including a step-by-step OpenCode configuration guide.

Changes:

  • Add a Guides section to README.md linking to the new documentation.
  • Introduce docs/guides/README.md as an index for integration guides.
  • Add docs/guides/configure-klaatu-in-opencode.md with OpenCode provider/agent setup, verification steps, and troubleshooting.
File summaries
File Description
README.md Adds a “Guides” section linking to the new docs area and OpenCode guide.
docs/guides/README.md New guides index page linking to the OpenCode integration guide.
docs/guides/configure-klaatu-in-opencode.md New detailed walkthrough for connecting OpenCode to Klaatu’s OpenAI-compatible Chat Completions API.
Review details

Suppressed comments (1)

docs/guides/configure-klaatu-in-opencode.md:10

  • Given the README emphasizes that klaatcode doesn’t require API keys, it would help to clarify here that the API key is specifically for authenticating OpenCode against Klaatu’s OpenAI-compatible endpoint (separate from klaatcode’s browser OAuth flow).
- A valid KlaatAI API key
  • Files reviewed: 3/3 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md

## Guides

Step-by-step integration guides live in [`docs/guides`](docs/guides/README.md).
@@ -0,0 +1,226 @@
# Configure Klaatu in OpenCode

KlaatAI exposes an OpenAI-compatible Chat Completions API. OpenCode can connect to it directly using the `@ai-sdk/openai-compatible` provider; no proxy is required.
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.

Docs: Add doc on how to configure OpenCode with Klaatai as provider with Klaatu Model

2 participants