moai-adk 0.25.4__py3-none-any.whl → 0.41.0__py3-none-any.whl

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

@@ -0,0 +1,181 @@
+---
+source: https://opencode.ai/docs/github/
+fetched: 2026-01-08
+title: GitHub Integration
+---
+
+# OpenCode GitHub Integration
+
+## Overview
+
+OpenCode enables AI-powered automation within GitHub workflows. The platform integrates with issues, pull requests, and scheduled tasks through GitHub Actions.
+
+## Core Capabilities
+
+### Triggering OpenCode
+
+Mention `/opencode` or `/oc` in your comment, and OpenCode will execute tasks within your GitHub Actions runner.
+
+### Common Use Cases
+
+- Request issue explanations
+- Implement fixes on new branches with PR submissions
+- Make targeted code changes
+- Automate code reviews
+- Schedule repository maintenance
+
+## Installation Methods
+
+### Automated Setup
+
+```bash
+opencode github install
+```
+
+### Manual Configuration
+
+1. Install the GitHub app at `github.com/apps/opencode-agent`
+2. Add a workflow YAML file to `.github/workflows/opencode.yml`
+3. Store API keys in GitHub Secrets
+
+### Workflow YAML Example
+
+```yaml
+name: OpenCode Agent
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+  issues:
+    types: [opened, edited]
+  pull_request:
+    types: [opened, synchronize]
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+jobs:
+  opencode:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: opencode-ai/opencode-action@v1
+        with:
+          model: anthropic/claude-sonnet-4
+        env:
+          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+```
+
+## Configuration Parameters
+
+| Parameter | Required | Description |
+|-----------|----------|-------------|
+| `model` | Yes | Specifies the AI model in `provider/model` format |
+| `agent` | No | Selects the processing agent; defaults to `default_agent` from config |
+| `share` | No | Controls session sharing (defaults to true for public repos) |
+| `prompt` | No | Customizes behavior through instructions |
+| `token` | No | Provides GitHub authentication; uses installation token by default |
+
+## Supported Event Types
+
+### Issue Comments
+
+Responds to comments on issues with full thread context.
+
+```yaml
+on:
+  issue_comment:
+    types: [created]
+```
+
+**Usage:**
+```
+/opencode Explain this issue and suggest a fix
+```
+
+### Pull Request Review Comments
+
+Responds to code review comments with line numbers and diffs.
+
+```yaml
+on:
+  pull_request_review_comment:
+    types: [created]
+```
+
+**Usage:**
+```
+/oc Can you improve this function?
+```
+
+### Issues Creation/Editing
+
+Automatically processes new or updated issues.
+
+```yaml
+on:
+  issues:
+    types: [opened, edited]
+```
+
+### Pull Request Events
+
+Responds to PR opens and updates.
+
+```yaml
+on:
+  pull_request:
+    types: [opened, synchronize]
+```
+
+### Scheduled Tasks (Cron)
+
+Runs on a schedule for maintenance tasks.
+
+```yaml
+on:
+  schedule:
+    - cron: '0 0 * * *'  # Daily at midnight
+```
+
+### Manual Dispatch
+
+Trigger workflows manually from GitHub UI.
+
+```yaml
+on:
+  workflow_dispatch:
+```
+
+## Common Applications
+
+### Code Review Automation
+
+```
+/opencode Review this PR for security issues and best practices
+```
+
+### Issue Triage
+
+```
+/oc Categorize this issue and suggest priority
+```
+
+### Feature Implementation
+
+```
+/opencode Implement the feature described in this issue and create a PR
+```
+
+### Repository Maintenance
+
+Schedule daily checks for outdated dependencies, security vulnerabilities, or code quality issues.
+
+## Best Practices
+
+1. **Store secrets securely:** Use GitHub Secrets for API keys
+2. **Limit permissions:** Use minimal required permissions
+3. **Review generated code:** Always review AI-generated changes before merging
+4. **Set appropriate triggers:** Choose triggers that match your workflow

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

@@ -0,0 +1,122 @@
+---
+source: https://opencode.ai/docs/gitlab/
+fetched: 2026-01-08
+title: GitLab Integration
+---
+
+# GitLab Integration for OpenCode
+
+## Overview
+
+OpenCode provides two integration methods for GitLab workflows:
+
+1. GitLab CI/CD Pipeline
+2. GitLab Duo Integration
+
+## GitLab CI/CD Pipeline
+
+OpenCode functions as a standard GitLab pipeline component using the community-maintained [nagyv/gitlab-opencode](https://gitlab.com/nagyv/gitlab-opencode) component.
+
+### Key Capabilities
+
+- Custom configuration per job invocation
+- Streamlined setup with minimal configuration needs
+- Flexible input parameters for behavior customization
+
+### Implementation
+
+1. Store authentication JSON as masked CI variables
+2. Add component reference to `.gitlab-ci.yml`
+3. Specify configuration directory and prompts
+
+### Example Configuration
+
+```yaml
+include:
+  - component: gitlab.com/nagyv/gitlab-opencode/opencode@main
+    inputs:
+      config_dir: .opencode
+      prompt: "Review this merge request"
+
+variables:
+  OPENCODE_AUTH: $OPENCODE_AUTH_JSON
+```
+
+## GitLab Duo Integration
+
+OpenCode operates within GitLab CI/CD pipelines, activated by mentioning `@opencode` in comments.
+
+### Supported Functions
+
+- Issue analysis and explanation
+- Automated fixes and feature implementation via merge requests
+- Code review capabilities
+
+### Setup Requirements
+
+1. **GitLab Environment Configuration**
+   - Configure GitLab CI/CD environment
+   - Set up pipeline triggers
+
+2. **API Key Acquisition**
+   - Obtain API key from an AI model provider
+
+3. **Service Account Creation**
+   - Create a dedicated service account for OpenCode
+
+4. **CI Variable Configuration**
+   - Store credentials as protected CI variables
+
+5. **Flow Configuration**
+   - Create configuration file with authentication steps
+
+### Usage Examples
+
+#### Request Issue Explanation
+
+```
+@opencode Explain this issue and identify the root cause
+```
+
+#### Implement Fixes
+
+```
+@opencode Implement a fix for this issue
+```
+
+The assistant handles:
+- Branch creation
+- Code implementation
+- Merge request generation
+
+#### Review Merge Requests
+
+```
+@opencode Review this merge request for security and performance
+```
+
+## Configuration File Example
+
+```yaml
+# .gitlab-ci.yml
+stages:
+  - opencode
+
+opencode:
+  stage: opencode
+  image: node:20
+  script:
+    - npm install -g opencode
+    - opencode run "$PROMPT"
+  variables:
+    ANTHROPIC_API_KEY: $ANTHROPIC_API_KEY
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+```
+
+## Best Practices
+
+1. **Use protected variables:** Store API keys as protected CI variables
+2. **Limit branch access:** Restrict which branches can trigger OpenCode
+3. **Review generated code:** Always review AI-generated merge requests
+4. **Set appropriate permissions:** Use minimal required GitLab permissions

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

@@ -0,0 +1,74 @@
+---
+source: https://opencode.ai/docs/ide/
+fetched: 2026-01-08
+title: IDE Integration
+---
+
+# OpenCode IDE Documentation
+
+## Overview
+
+This documentation covers the OpenCode extension for VS Code, Cursor, and other IDEs that support terminal integration.
+
+## Keyboard Shortcuts
+
+| Action | macOS | Windows/Linux |
+|--------|-------|---------------|
+| Quick launch | `Cmd+Esc` | `Ctrl+Esc` |
+| New session | `Cmd+Shift+Esc` | `Ctrl+Shift+Esc` |
+| Insert file reference | `Cmd+Option+K` | `Alt+Ctrl+K` |
+
+### File References
+
+The file reference shortcut enables quick insertion like `@File#L37-42`. The tool automatically shares current selection or active tab with OpenCode.
+
+## Installation
+
+### Automatic Installation
+
+The extension installs automatically when running the `opencode` command in VS Code's integrated terminal.
+
+### Manual Installation
+
+1. Open the Extension Marketplace in your IDE
+2. Search for "OpenCode"
+3. Click Install
+
+## Supported IDEs
+
+- VS Code
+- Cursor
+- Windsurf
+- Codium
+
+## Troubleshooting
+
+If automatic installation fails:
+
+1. **Run in integrated terminal:** Run `opencode` specifically in the integrated terminal (not an external terminal)
+
+2. **Verify CLI tools:** Ensure IDE CLI tools are installed:
+   - `code` (VS Code)
+   - `cursor` (Cursor)
+   - `windsurf` (Windsurf)
+   - `codium` (Codium)
+
+3. **Install shell commands:** Use command palette (`Cmd+Shift+P` or `Ctrl+Shift+P`) to install shell commands in PATH
+
+4. **Check permissions:** Confirm VS Code extension installation permissions are enabled
+
+## Editor Configuration
+
+For using custom editors with `/editor` or `/export` commands, set the `EDITOR` environment variable:
+
+```bash
+export EDITOR="code --wait"
+```
+
+The `--wait` flag ensures the editor blocks until the file is closed.
+
+## Usage Tips
+
+- Use file references to quickly share code context
+- The extension automatically detects active selections
+- Works with multiple IDE instances simultaneously

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

@@ -0,0 +1,106 @@
+---
+source: https://opencode.ai/docs/share/
+fetched: 2026-01-08
+title: Share Feature
+---
+
+# OpenCode Share Feature Documentation
+
+## Overview
+
+OpenCode enables users to create public links for conversations, facilitating collaboration.
+
+**Important:** "Shared conversations are publicly accessible to anyone with the link."
+
+## How It Works
+
+The sharing mechanism operates in three steps:
+
+1. Generates a unique public URL for the session
+2. Synchronizes conversation history to OpenCode servers
+3. Makes content accessible via the format `opncd.ai/s/<share-id>`
+
+## Sharing Modes
+
+### Manual (Default)
+
+Users must explicitly invoke `/share` to generate a shareable URL copied to clipboard.
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "share": "manual"
+}
+```
+
+### Auto-Share
+
+Enabling automatic sharing shares all new conversations automatically:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "share": "auto"
+}
+```
+
+### Disabled
+
+Completely prevents sharing functionality:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "share": "disabled"
+}
+```
+
+## Un-sharing
+
+The `/unshare` command removes public access and deletes associated conversation data.
+
+```bash
+/unshare
+```
+
+## Privacy Considerations
+
+### Data Retention
+
+Shared conversations persist until explicitly unshared, including:
+- Full conversation history
+- Metadata
+
+### Key Recommendations
+
+1. **Review before sharing:** Check content for sensitive information
+2. **Avoid sensitive data:** Do not share conversations containing:
+   - Proprietary code
+   - Confidential data
+   - API keys or credentials
+3. **Unshare after collaboration:** Remove access when no longer needed
+4. **Disable for sensitive projects:** Use `"share": "disabled"` for confidential work
+
+## Enterprise Options
+
+For organizational deployments, sharing can be:
+
+| Option | Description |
+|--------|-------------|
+| Disabled | Completely prevent sharing for compliance |
+| SSO-restricted | Allow only authenticated users |
+| Self-hosted | Host share pages on internal infrastructure |
+
+## Commands Reference
+
+| Command | Description |
+|---------|-------------|
+| `/share` | Generate shareable link (copies to clipboard) |
+| `/unshare` | Remove public access and delete data |
+
+## URL Format
+
+Shared conversations use the format:
+```
+https://opncd.ai/s/<share-id>
+```

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

@@ -0,0 +1,129 @@
+---
+source: https://opencode.ai/docs/tui/
+fetched: 2026-01-08
+title: Terminal User Interface (TUI)
+---
+
+# OpenCode TUI Documentation
+
+## Overview
+
+OpenCode provides an interactive terminal interface (TUI) for working on projects with an LLM. Launch it by running `opencode` in your project directory or specify a path:
+
+```bash
+opencode
+# or
+opencode /path/to/project
+```
+
+## File References
+
+Users can reference files in messages using `@` to perform fuzzy file searching within the current working directory.
+
+**Example:**
+```
+How is auth handled in @packages/functions/src/api/index.ts?
+```
+
+The file content is automatically included in conversations.
+
+## Bash Commands
+
+Messages beginning with `!` execute shell commands. The command output is then added to the conversation as a tool result.
+
+**Example:**
+```
+!npm test
+```
+
+## Commands (Slash Commands)
+
+All commands use `/` prefix and most include `ctrl+x` keybind shortcuts (ctrl+x is the default leader key):
+
+| Command | Aliases | Description | Keybind |
+|---------|---------|-------------|---------|
+| `/connect` | - | Add a provider and configure API keys | - |
+| `/compact` | `/summarize` | Compact current session | `ctrl+x c` |
+| `/details` | - | Toggle tool execution details | `ctrl+x d` |
+| `/editor` | - | Open external editor for message composition | `ctrl+x e` |
+| `/exit` | `/quit`, `/q` | Exit OpenCode | `ctrl+x q` |
+| `/export` | - | Export conversation to Markdown | `ctrl+x x` |
+| `/help` | - | Show help dialog | `ctrl+x h` |
+| `/init` | - | Create/update AGENTS.md file | `ctrl+x i` |
+| `/models` | - | List available models | `ctrl+x m` |
+| `/new` | `/clear` | Start new session | `ctrl+x n` |
+| `/redo` | - | Redo previously undone message | `ctrl+x r` |
+| `/sessions` | `/resume`, `/continue` | List/switch sessions | `ctrl+x l` |
+| `/share` | - | Share current session | `ctrl+x s` |
+| `/themes` | - | List available themes | `ctrl+x t` |
+| `/undo` | - | Undo last message and revert file changes | `ctrl+x u` |
+| `/unshare` | - | Unshare current session | - |
+
+## Editor Setup
+
+The `EDITOR` environment variable controls which editor opens for `/editor` and `/export` commands.
+
+### Linux/macOS
+
+```bash
+export EDITOR=nano
+export EDITOR=vim
+export EDITOR="code --wait"
+```
+
+### Windows CMD
+
+```cmd
+set EDITOR=notepad
+set EDITOR="code --wait"
+```
+
+### Windows PowerShell
+
+```powershell
+$env:EDITOR = "notepad"
+$env:EDITOR = "code --wait"
+```
+
+### Popular Editors
+
+| Editor | Command |
+|--------|---------|
+| VS Code | `code` |
+| Cursor | `cursor` |
+| Windsurf | `windsurf` |
+| Neovim | `nvim` |
+| Vim | `vim` |
+| Nano | `nano` |
+| Sublime | `subl` |
+
+**Note:** Some editors like VS Code need to be started with the `--wait` flag to block until closed.
+
+## Configuration
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "tui": {
+    "scroll_speed": 3,
+    "scroll_acceleration": {
+      "enabled": true
+    }
+  }
+}
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `scroll_acceleration` | Enable macOS-style scroll acceleration; takes precedence over scroll_speed |
+| `scroll_speed` | Controls scroll speed (minimum: 1); defaults to 1 on Unix, 3 on Windows; ignored if scroll_acceleration is enabled |
+
+## Customization
+
+Users can customize TUI view settings through the command palette (`ctrl+x h` or `/help`). Settings persist across restarts.
+
+### Username Display
+
+Toggle whether your username appears in chat messages through the command palette by searching "username" or "hide username."