moai-adk 0.32.8__py3-none-any.whl → 0.41.2__py3-none-any.whl

moai_adk/templates/.claude/skills/moai-tool-opencode/modules/develop/sdk.md

@@ -0,0 +1,266 @@
+---
+source: https://opencode.ai/docs/sdk/
+fetched: 2026-01-08
+title: SDK
+---
+
+# OpenCode SDK Documentation
+
+## Overview
+
+The OpenCode SDK is a type-safe JavaScript/TypeScript client for interacting with the OpenCode server. It enables programmatic control and integration capabilities.
+
+## Installation
+
+```bash
+npm install @opencode-ai/sdk
+```
+
+## Setup
+
+### Full Client (Starts Server)
+
+Create a client instance that starts both server and client:
+
+```javascript
+import { createOpencode } from "@opencode-ai/sdk"
+
+const { client } = await createOpencode()
+```
+
+### Configuration Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `hostname` | `127.0.0.1` | Server hostname |
+| `port` | `4096` | Server port |
+| `abortSignal` | - | Abort signal for cancellation |
+| `timeout` | `5000` | Request timeout in ms |
+| `config` | - | Configuration object |
+
+### Client-Only Mode
+
+For existing server instances:
+
+```javascript
+import { createOpencodeClient } from "@opencode-ai/sdk"
+
+const client = createOpencodeClient({
+  baseUrl: "http://localhost:4096"
+})
+```
+
+## Core APIs
+
+### Global
+
+Health checks returning version information:
+
+```javascript
+const health = await client.global.health()
+console.log(health.version)
+```
+
+### App
+
+Logging entries and listing available agents:
+
+```javascript
+// Log an entry
+await client.app.log({ level: "info", message: "Hello" })
+
+// List agents
+const agents = await client.app.agents()
+```
+
+### Project
+
+List and retrieve current project information:
+
+```javascript
+const project = await client.project.get()
+console.log(project.name, project.path)
+```
+
+### Sessions
+
+Comprehensive session management:
+
+```javascript
+// Create session
+const session = await client.session.create({
+  title: "My Session"
+})
+
+// List sessions
+const sessions = await client.session.list()
+
+// Get session
+const existing = await client.session.get(sessionId)
+
+// Delete session
+await client.session.delete(sessionId)
+
+// Share session
+const shareUrl = await client.session.share(sessionId)
+```
+
+### Files
+
+Search capabilities and file reading:
+
+```javascript
+// Text search
+const results = await client.file.search({
+  query: "function",
+  type: "text"
+})
+
+// Read file
+const content = await client.file.read(filePath)
+
+// File status
+const status = await client.file.status(filePath)
+```
+
+### TUI
+
+Terminal UI control:
+
+```javascript
+// Append prompt
+await client.tui.prompt({ text: "Hello" })
+
+// Show toast
+await client.tui.toast({ message: "Success!" })
+
+// Execute command
+await client.tui.command({ name: "init" })
+
+// Open dialog
+await client.tui.dialog({ type: "confirm", message: "Proceed?" })
+```
+
+### Auth
+
+Set authentication credentials for providers:
+
+```javascript
+await client.auth.set({
+  provider: "anthropic",
+  apiKey: "sk-..."
+})
+```
+
+### Events
+
+Server-sent events stream for real-time updates:
+
+```javascript
+const events = client.events.subscribe()
+
+for await (const event of events) {
+  console.log(event.type, event.data)
+}
+```
+
+## Session Operations
+
+### Send Message
+
+```javascript
+const response = await client.session.prompt(sessionId, {
+  content: "Explain this code",
+  context: "@src/index.ts"
+})
+```
+
+### Execute Command
+
+```javascript
+await client.session.command(sessionId, {
+  name: "init"
+})
+```
+
+### Execute Shell
+
+```javascript
+const output = await client.session.shell(sessionId, {
+  command: "npm test"
+})
+```
+
+### Share Session
+
+```javascript
+const url = await client.session.share(sessionId)
+```
+
+### Context Injection (No Reply)
+
+Inject context without triggering AI response:
+
+```javascript
+await client.session.prompt(sessionId, {
+  content: "Context information",
+  noReply: true
+})
+```
+
+## Types & Error Handling
+
+### TypeScript Types
+
+```typescript
+import type {
+  Session,
+  Message,
+  Part,
+  Project,
+  Agent
+} from "@opencode-ai/sdk"
+```
+
+### Error Handling
+
+```javascript
+try {
+  const session = await client.session.get(sessionId)
+} catch (error) {
+  if (error.status === 404) {
+    console.log("Session not found")
+  }
+}
+```
+
+## Full Example
+
+```javascript
+import { createOpencode } from "@opencode-ai/sdk"
+
+async function main() {
+  // Start server and client
+  const { client } = await createOpencode({
+    port: 4096
+  })
+
+  // Create a session
+  const session = await client.session.create({
+    title: "Code Review"
+  })
+
+  // Send a prompt
+  const response = await client.session.prompt(session.id, {
+    content: "Review the code in @src/main.ts"
+  })
+
+  console.log(response.content)
+
+  // Share the session
+  const shareUrl = await client.session.share(session.id)
+  console.log("Shared at:", shareUrl)
+}
+
+main()
+```

moai_adk/templates/.claude/skills/moai-tool-opencode/modules/develop/server.md

@@ -0,0 +1,207 @@
+---
+source: https://opencode.ai/docs/server/
+fetched: 2026-01-08
+title: Server
+---
+
+# OpenCode Server Documentation
+
+## Overview
+
+The OpenCode server is a headless HTTP service that exposes an OpenAPI endpoint, enabling programmatic interaction with OpenCode. When you run the standard `opencode` command, it launches both a TUI client and a backend server simultaneously.
+
+## Core Features
+
+### Architecture
+
+"This architecture lets opencode support multiple clients and allows you to interact with opencode programmatically."
+
+```
+┌──────────────────────────────────────────────────────┐
+│                    OpenCode                           │
+├──────────────────────────────────────────────────────┤
+│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐  │
+│  │     TUI     │  │   IDE Ext   │  │   SDK App   │  │
+│  │   Client    │  │   Client    │  │   Client    │  │
+│  └──────┬──────┘  └──────┬──────┘  └──────┬──────┘  │
+│         │                │                │          │
+│         └────────────────┼────────────────┘          │
+│                          │                           │
+│                   ┌──────▼──────┐                    │
+│                   │   OpenCode  │                    │
+│                   │   Server    │                    │
+│                   │  (HTTP API) │                    │
+│                   └─────────────┘                    │
+└──────────────────────────────────────────────────────┘
+```
+
+### Server Startup
+
+Launch a standalone server:
+
+```bash
+opencode serve
+```
+
+### Server Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--port` | `4096` | Server port |
+| `--hostname` | `127.0.0.1` | Server hostname |
+| `--mdns` | `false` | Enable mDNS discovery |
+| `--cors` | - | CORS origins (comma-separated) |
+
+### Configuration
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "server": {
+    "port": 4096,
+    "hostname": "127.0.0.1",
+    "mdns": true,
+    "cors": ["http://localhost:3000"]
+  }
+}
+```
+
+## API Categories
+
+### Global
+
+Health checks and event streaming:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/health` | GET | Health check |
+| `/events` | GET | SSE event stream |
+
+### Project/VCS
+
+Project information and version control:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/project` | GET | Get current project |
+| `/project/vcs` | GET | Version control info |
+
+### Sessions
+
+Session management:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/session` | GET | List sessions |
+| `/session` | POST | Create session |
+| `/session/:id` | GET | Get session |
+| `/session/:id` | DELETE | Delete session |
+| `/session/:id/share` | POST | Share session |
+
+### Messages
+
+Sending prompts and handling responses:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/session/:id/message` | POST | Send sync message |
+| `/session/:id/prompt_async` | POST | Send async message |
+| `/session/:id/command` | POST | Execute command |
+| `/session/:id/shell` | POST | Execute shell |
+
+### Files
+
+Search and read operations:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/file/search` | POST | Search files |
+| `/file/:path` | GET | Read file |
+| `/file/:path/status` | GET | File status |
+
+### Configuration
+
+Provider and model configuration:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/config/provider` | POST | Set provider |
+| `/config/model` | POST | Set model |
+
+### Tools & LSP
+
+Tool access and language server status:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/tool` | GET | List tools |
+| `/tool/:name` | POST | Execute tool |
+| `/lsp` | GET | LSP status |
+
+### Agents
+
+Available agents:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/agent` | GET | List agents |
+
+### TUI Control
+
+Remote terminal interface manipulation:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/tui/prompt` | POST | Prefill prompt |
+| `/tui/toast` | POST | Show toast |
+| `/tui/command` | POST | Execute command |
+| `/tui/dialog` | POST | Open dialog |
+
+## Notable Capabilities
+
+### IDE Integration
+
+The `/tui` endpoints enable external applications (like IDE plugins) to prefill prompts and drive the interface remotely.
+
+### Async Operations
+
+The `/session/:id/prompt_async` endpoint enables fire-and-forget operations, useful for background processing.
+
+### OpenAPI Specification
+
+Full OpenAPI 3.1 specification is available at the `/doc` endpoint for schema validation and client generation.
+
+```bash
+# Get OpenAPI spec
+curl http://localhost:4096/doc
+```
+
+## Example Usage
+
+### Start Server
+
+```bash
+opencode serve --port 4096 --hostname 0.0.0.0
+```
+
+### Health Check
+
+```bash
+curl http://localhost:4096/health
+```
+
+### Create Session
+
+```bash
+curl -X POST http://localhost:4096/session \
+  -H "Content-Type: application/json" \
+  -d '{"title": "My Session"}'
+```
+
+### Send Message
+
+```bash
+curl -X POST http://localhost:4096/session/abc123/message \
+  -H "Content-Type: application/json" \
+  -d '{"content": "Explain this codebase"}'
+```

moai_adk/templates/.claude/skills/moai-tool-opencode/modules/usage/cli.md

@@ -0,0 +1,159 @@
+---
+source: https://opencode.ai/docs/cli/
+fetched: 2026-01-08
+title: Command Line Interface (CLI)
+---
+
+# OpenCode CLI Documentation
+
+## Overview
+
+OpenCode is a CLI tool that defaults to launching a terminal user interface (TUI) when run without arguments. It supports both interactive and programmatic modes, allowing users to interact with the system through various commands and flags.
+
+## Basic Usage
+
+```bash
+# Launch TUI in current directory
+opencode
+
+# Launch TUI in specific directory
+opencode /path/to/project
+
+# Run non-interactive with a prompt
+opencode run "Your prompt here"
+```
+
+## Global Flags
+
+| Flag | Description |
+|------|-------------|
+| `--help` | Display help information |
+| `--version` | Display version information |
+| `--print-logs` | Print logs to stdout |
+| `--log-level` | Set logging level (DEBUG, INFO, WARN, ERROR) |
+
+## Core Commands
+
+### Agent Management
+
+Create, list, and manage custom agents with configurable system prompts and tool configurations.
+
+```bash
+opencode agent list
+opencode agent create my-agent
+```
+
+### Authentication
+
+Handle credentials across multiple providers.
+
+```bash
+opencode auth login
+opencode auth list
+opencode auth logout
+```
+
+Credentials are stored in `~/.local/share/opencode/auth.json`.
+
+### Session Control
+
+List, export, and import session data in JSON format.
+
+```bash
+opencode session list
+opencode session export <session-id>
+opencode session import <file.json>
+```
+
+Supports OpenCode share URLs for importing sessions.
+
+### Model Operations
+
+Display available models from configured providers in `provider/model` format.
+
+```bash
+opencode models
+opencode models --refresh  # Refresh cache
+```
+
+### Server Modes
+
+**Headless HTTP API Server:**
+```bash
+opencode serve
+```
+
+**HTTP Server with Web Browser Interface:**
+```bash
+opencode web
+```
+
+**Agent Client Protocol Server (stdin/stdout):**
+```bash
+opencode acp
+```
+
+### GitHub Integration
+
+Install workflows and run agents within GitHub Actions environments.
+
+```bash
+opencode github install
+opencode github run
+```
+
+### MCP Server Management
+
+Add, list, and authenticate Model Context Protocol servers with OAuth support.
+
+```bash
+opencode mcp add <server-name>
+opencode mcp list
+opencode mcp auth <server-name>
+```
+
+## Non-Interactive Mode
+
+The `opencode run` command enables non-interactive execution:
+
+```bash
+opencode run "Your prompt here"
+```
+
+"Run opencode in non-interactive mode by passing a prompt directly."
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `OPENCODE_CONFIG_DIR` | Custom configuration directory |
+| `OPENCODE_DISABLE_AUTOUPDATE` | Disable automatic updates |
+
+## Advanced Features
+
+### Attachment Capability
+
+Connect to running servers to avoid cold boot times on subsequent invocations.
+
+### Experimental Flags
+
+Advanced features may be available through experimental flags. Check `--help` for current options.
+
+## Examples
+
+```bash
+# Start TUI with debug logging
+opencode --log-level DEBUG
+
+# Run a quick prompt
+opencode run "Explain the authentication flow in this codebase"
+
+# Start headless server on custom port
+opencode serve --port 8080
+
+# List all available models
+opencode models
+
+# Export current session
+opencode session export my-session > session.json
+```