@vicoa/opencode 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,104 @@
+# OpenCode Plugin for Vicoa
+
+A plugin for OpenCode that enables you to ship faster with OpenCode on your phone!
+
+OpenCode plugin for [Vicoa](https://vicoa.ai) to vibe code anywhere.
+
+## Features
+
+- **Push Notifications** - Get notified when OpenCode needs approval or finishes tasks
+- **Real-time Monitoring** - See all opencode progress in your phone
+- **Bidirectional Messaging** - Send messages to OpenCode from your phone
+- **Permission Approval** - Approve permissions on the go
+- **File Fuzzy Search** - Reference project files quickly on your phone
+- **Command Execution** - Execute OpenCode commands from your phone
+
+## Installation
+
+This plugin works with Vicoa CLI, web, and mobile app. 
+
+## Installation vis Vicoa (Recommended)
+
+You can install `vicoa` CLI with:
+
+```bash
+pip install vicoa
+``` 
+
+Then, run the following command to install the plugin and link Vicoa with OpenCode:
+
+```bash
+vicoa opencode
+```
+
+After authentication via the web portal, you are set to use OpenCode anywhere you go.
+
+You can reference [Vicoa Setup Guide](https://vicoa.ai/docs/getting-started) for more details.
+
+## Manual Installation
+
+Add the plugin to OpenCode config (`~/.config/opencode/config.json`):
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugins": ["opencode-vicoa"]
+}
+```
+
+Then, you'll still need to install Vicoa CLI and authenticate with it to set the Vicoa API key. 
+
+You can also get the API key manually from the Vicoa dashboard, then set it with:
+
+```bash
+export VICOA_API_KEY="your-vicoa-api-key"
+```
+
+
+### For Development
+
+1. Clone the repository
+
+```bash
+git clone https://github.com/vicoa-ai/opencode-vicoa.git
+```
+
+2. Install and build the package:
+
+```bash
+npm install
+npm run build
+```
+
+3. Add the local plugin version to OpenCode config:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugins": ["file://<path/to/opencode-vicoa>"]
+}
+```
+
+## Usage
+
+You can either use the Vicoa CLI to start OpenCode, or run OpenCode directly.
+
+1. After initial setup, you can run OpenCode directly and it'll sync with Vicoa automatically.
+
+```bash
+opencode
+```
+
+2. You can also use the Vicoa CLI to start OpenCode:
+
+```bash
+vicoa opencode
+```
+
+It additional prepares files for fuzzy search on Vicoa mobile and web apps. 
+
+You can also upgrade the plugin with 
+
+```bash
+vicoa opencode --upgrade
+```

package/dist/commands.d.ts

@@ -0,0 +1,24 @@
+import type { VicoaClient } from './vicoa-client.js';
+export declare const OPENCODE_SLASH_AGENT_TYPE = "opencode";
+export declare const OPENCODE_SLASH_COMMAND_ACTIONS: Record<string, string>;
+export declare const OPENCODE_EXECUTE_COMMAND_KEYS: Record<string, string>;
+/**
+ * Execute a TUI command via the OpenCode client.
+ */
+export declare function executeTuiCommand(client: any, command: string): Promise<void>;
+export type OpencodeCommandMap = Record<string, {
+    description: string;
+}>;
+export type ParsedSlashCommand = {
+    name: string;
+    rawName: string;
+    arguments: string;
+};
+export declare function parseSlashCommand(input: string): ParsedSlashCommand | null;
+export declare function scanOpencodeCommands(projectDir: string | undefined, homeDir: string): Promise<OpencodeCommandMap>;
+/**
+ * Handle slash command execution. Returns true if the command was executed
+ * directly (built-in with no arguments), false if it should be submitted as
+ * a prompt (built-in with args, custom command, or unknown command).
+ */
+export declare function handleSlashCommand(userMessage: string, client: any, currentSessionId?: string, vicoaClient?: VicoaClient): Promise<boolean>;

package/dist/commands.js

@@ -0,0 +1,228 @@
+import path from 'path';
+import * as fs from 'fs/promises';
+import { log } from './plugin/utils.js';
+export const OPENCODE_SLASH_AGENT_TYPE = 'opencode';
+export const OPENCODE_SLASH_COMMAND_ACTIONS = {
+    sessions: 'session.list',
+    resume: 'session.list',
+    continue: 'session.list',
+    new: 'session.new',
+    clear: 'session.new',
+    models: 'model.list',
+    agents: 'agent.list',
+    mcps: 'mcp.list',
+    connect: 'provider.connect',
+    status: 'opencode.status',
+    themes: 'theme.switch',
+    help: 'help.show',
+    exit: 'app.exit',
+    quit: 'app.exit',
+    q: 'app.exit',
+    editor: 'prompt.editor',
+    share: 'session.share',
+    rename: 'session.rename',
+    timeline: 'session.timeline',
+    fork: 'session.fork',
+    compact: 'session.compact',
+    summarize: 'session.compact',
+    unshare: 'session.unshare',
+    undo: 'session.undo',
+    redo: 'session.redo',
+    timestamps: 'session.toggle.timestamps',
+    'toggle-timestamps': 'session.toggle.timestamps',
+    thinking: 'session.toggle.thinking',
+    'toggle-thinking': 'session.toggle.thinking',
+    copy: 'session.copy',
+    export: 'session.export',
+};
+export const OPENCODE_EXECUTE_COMMAND_KEYS = {
+    'session.new': 'session_new',
+    'session.share': 'session_share',
+    'session.interrupt': 'session_interrupt',
+    'session.compact': 'session_compact',
+    'session.page.up': 'messages_page_up',
+    'session.page.down': 'messages_page_down',
+    'session.line.up': 'messages_line_up',
+    'session.line.down': 'messages_line_down',
+    'session.half.page.up': 'messages_half_page_up',
+    'session.half.page.down': 'messages_half_page_down',
+    'session.first': 'messages_first',
+    'session.last': 'messages_last',
+    'agent.cycle': 'agent_cycle',
+};
+/**
+ * Execute a TUI command via the OpenCode client.
+ */
+export async function executeTuiCommand(client, command) {
+    const executeKey = OPENCODE_EXECUTE_COMMAND_KEYS[command];
+    if (executeKey) {
+        await client.tui.executeCommand({ body: { command: executeKey } });
+        return;
+    }
+    await client.tui.publish({
+        body: {
+            type: 'tui.command.execute',
+            properties: { command },
+        },
+    });
+}
+export function parseSlashCommand(input) {
+    const trimmed = input.trim();
+    if (!trimmed.startsWith('/')) {
+        return null;
+    }
+    const body = trimmed.slice(1).trim();
+    if (!body) {
+        return null;
+    }
+    const [rawName, ...rest] = body.split(/\s+/);
+    if (!rawName) {
+        return null;
+    }
+    return {
+        rawName,
+        name: rawName.toLowerCase(),
+        arguments: rest.join(' ').trim(),
+    };
+}
+async function pathExists(target) {
+    try {
+        await fs.stat(target);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+async function walkMarkdownFiles(root) {
+    const results = [];
+    if (!(await pathExists(root))) {
+        return results;
+    }
+    const entries = await fs.readdir(root, { withFileTypes: true });
+    for (const entry of entries) {
+        const fullPath = path.join(root, entry.name);
+        if (entry.isDirectory()) {
+            results.push(...(await walkMarkdownFiles(fullPath)));
+        }
+        else if (entry.isFile() && entry.name.toLowerCase().endsWith('.md')) {
+            results.push(fullPath);
+        }
+    }
+    return results;
+}
+function getOpencodeCommandRoots(projectDir, homeDir) {
+    const roots = new Set();
+    if (process.env.OPENCODE_CONFIG_DIR) {
+        roots.add(process.env.OPENCODE_CONFIG_DIR);
+    }
+    if (process.env.XDG_CONFIG_HOME) {
+        roots.add(path.join(process.env.XDG_CONFIG_HOME, 'opencode'));
+    }
+    roots.add(path.join(homeDir, '.config', 'opencode'));
+    if (process.platform === 'win32') {
+        const appData = process.env.APPDATA || path.join(homeDir, 'AppData', 'Roaming');
+        roots.add(path.join(appData, 'opencode'));
+    }
+    // ~/.opencode fallback (all platforms).
+    roots.add(path.join(homeDir, '.opencode'));
+    // Per-project override.
+    if (projectDir) {
+        roots.add(path.join(projectDir, '.opencode'));
+    }
+    return Array.from(roots);
+}
+function parseCommandDescription(content, fallbackName) {
+    const lines = content.split('\n');
+    let description = '';
+    if (lines.length > 0 && lines[0].trim() === '---') {
+        for (let i = 1; i < lines.length; i += 1) {
+            const line = lines[i].trim();
+            if (line === '---') {
+                break;
+            }
+            const [key, value] = line.split(':', 2).map((item) => item?.trim());
+            if (key?.toLowerCase() === 'description' && value) {
+                description = value.replace(/^['"]|['"]$/g, '').trim();
+                break;
+            }
+        }
+    }
+    if (!description) {
+        for (const line of lines) {
+            const stripped = line.trim();
+            if (!stripped) {
+                continue;
+            }
+            description = stripped.startsWith('#') ? stripped.replace(/^#+/, '').trim() : stripped;
+            break;
+        }
+    }
+    return description || `Custom command: ${fallbackName}`;
+}
+export async function scanOpencodeCommands(projectDir, homeDir) {
+    const commands = {};
+    const roots = getOpencodeCommandRoots(projectDir, homeDir);
+    for (const root of roots) {
+        const commandRoot = path.join(root, 'commands');
+        const files = await walkMarkdownFiles(commandRoot);
+        for (const filePath of files) {
+            const relativePath = path.relative(commandRoot, filePath);
+            const normalized = relativePath.split(path.sep).join('/');
+            const commandName = normalized.replace(/\.md$/i, '');
+            if (!commandName) {
+                continue;
+            }
+            try {
+                const content = await fs.readFile(filePath, 'utf-8');
+                const description = parseCommandDescription(content, commandName);
+                commands[commandName] = { description };
+            }
+            catch {
+                continue;
+            }
+        }
+    }
+    return commands;
+}
+/**
+ * Handle slash command execution. Returns true if the command was executed
+ * directly (built-in with no arguments), false if it should be submitted as
+ * a prompt (built-in with args, custom command, or unknown command).
+ */
+export async function handleSlashCommand(userMessage, client, currentSessionId, vicoaClient) {
+    const parsed = parseSlashCommand(userMessage);
+    if (!parsed) {
+        return false;
+    }
+    const action = OPENCODE_SLASH_COMMAND_ACTIONS[parsed.name];
+    // Built-in command with no arguments — use the direct TUI action shortcut.
+    if (action && !parsed.arguments) {
+        // Special handling for /share command: call the API directly to get the URL
+        if (parsed.name === 'share' && currentSessionId && vicoaClient) {
+            try {
+                const { data: session } = await client.session.share({
+                    path: { id: currentSessionId },
+                });
+                if (session?.share?.url) {
+                    await vicoaClient.sendMessage(`Share url: ${session.share.url}`);
+                    log(client, 'info', `[Vicoa] Shared session and sent URL to UI: ${session.share.url}`);
+                }
+                else {
+                    log(client, 'warn', '[Vicoa] Session shared but no URL in response');
+                }
+                return true;
+            }
+            catch (error) {
+                log(client, 'warn', `[Vicoa] Failed to share session: ${error}`);
+                // Fall back to TUI command if API call fails
+            }
+        }
+        await executeTuiCommand(client, action);
+        log(client, 'info', `[Vicoa] Executed slash command: /${parsed.rawName}`);
+        return true;
+    }
+    // Built-in with arguments, or a custom command — fall through so the raw
+    // slash command text is submitted as a prompt (OpenCode parses args natively).
+    return false;
+}

package/dist/credentials.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Credentials loader for Vicoa
+ *
+ * Reads API key from ~/.vicoa/credentials.json (same as Vicoa CLI)
+ */
+export interface Credentials {
+    write_key?: string;
+}
+/**
+ * Get path to Vicoa credentials file
+ */
+export declare function getCredentialsPath(): string;
+/**
+ * Load Vicoa API key from credentials file
+ *
+ * Returns the API key from ~/.vicoa/credentials.json if it exists,
+ * otherwise returns null.
+ */
+export declare function loadApiKey(): string | null;
+/**
+ * Get Vicoa API key from environment or credentials file
+ *
+ * Priority:
+ * 1. VICOA_API_KEY environment variable
+ * 2. ~/.vicoa/credentials.json (write_key)
+ */
+export declare function getApiKey(): string | null;

package/dist/credentials.js

@@ -0,0 +1,56 @@
+/**
+ * Credentials loader for Vicoa
+ *
+ * Reads API key from ~/.vicoa/credentials.json (same as Vicoa CLI)
+ */
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+/**
+ * Get path to Vicoa credentials file
+ */
+export function getCredentialsPath() {
+    return path.join(os.homedir(), '.vicoa', 'credentials.json');
+}
+/**
+ * Load Vicoa API key from credentials file
+ *
+ * Returns the API key from ~/.vicoa/credentials.json if it exists,
+ * otherwise returns null.
+ */
+export function loadApiKey() {
+    const credentialsPath = getCredentialsPath();
+    // Check if file exists
+    if (!fs.existsSync(credentialsPath)) {
+        return null;
+    }
+    try {
+        const data = fs.readFileSync(credentialsPath, 'utf-8');
+        const credentials = JSON.parse(data);
+        const apiKey = credentials.write_key;
+        if (apiKey && typeof apiKey === 'string' && apiKey.trim().length > 0) {
+            return apiKey.trim();
+        }
+        return null;
+    }
+    catch (error) {
+        console.error(`[Vicoa] Error reading credentials file: ${error}`);
+        return null;
+    }
+}
+/**
+ * Get Vicoa API key from environment or credentials file
+ *
+ * Priority:
+ * 1. VICOA_API_KEY environment variable
+ * 2. ~/.vicoa/credentials.json (write_key)
+ */
+export function getApiKey() {
+    // Check environment variable first
+    const envKey = process.env.VICOA_API_KEY;
+    if (envKey && envKey.trim().length > 0) {
+        return envKey.trim();
+    }
+    // Fall back to credentials file
+    return loadApiKey();
+}

package/dist/format-utils.d.ts

@@ -0,0 +1,10 @@
+import type { FilePart, PatchPart, ReasoningPart, ToolPart } from '@opencode-ai/sdk';
+type ToolInput = Record<string, unknown>;
+export declare function formatToolUsage(toolName: string, inputData: ToolInput): string;
+export declare function formatToolResult(output: string, toolName?: string): string;
+export declare function shouldSuppressToolOutput(toolName: string): boolean;
+export declare function formatToolPart(toolPart: ToolPart): string;
+export declare function formatReasoningPart(part: ReasoningPart): string;
+export declare function formatFilePart(part: FilePart): string;
+export declare function formatPatchPart(part: PatchPart): string;
+export {};