mirror of
https://github.com/Heretek-AI/awesome-opencode.git
synced 2026-11-07 10:45:57 -10:00
Entries gain a fixed kind and 1-3 topics (replacing 374 one-off tags as the categorization axis), an OpenCode API compat field (required for plugins), and npm/path for packages and monorepo folders. repo must be a repository root; unknown fields such as install: or repository: are rejected. Cross-entry rules (one entry per repo+path, kind must fit the category, no placeholder owners or mojibake) live in scripts/utils/catalog.js, and validate.js now always loads the whole catalog and fails on unparseable YAML. Adds npm run fmt for canonical formatting and drops the unused glob dependency. Co-Authored-By: Claude Opus 5.5 <[email protected]>
76 lines
2.0 KiB
YAML
76 lines
2.0 KiB
YAML
# Example Project Entry
|
|
# Projects are standalone applications and utilities built for/with OpenCode.
|
|
# These are complete apps, not extensions.
|
|
# Place actual entries in: data/projects/your-project-name.yaml
|
|
|
|
# ============================================================================
|
|
# REQUIRED FIELDS
|
|
# ============================================================================
|
|
|
|
name: Example OpenCode Dashboard
|
|
repo: https://github.com/example/opencode-dashboard
|
|
tagline: Web-based dashboard for monitoring OpenCode sessions
|
|
description: A standalone web application for monitoring and managing
|
|
OpenCode sessions across multiple projects.
|
|
|
|
Features
|
|
- Real-time session monitoring
|
|
- Token usage analytics
|
|
- Multi-project overview
|
|
|
|
kind: client # plugin, theme, agent, skill, mcp-server, client, tool, config, guide, fork
|
|
topics: # 1-3 from the fixed list in data/schema.json; the first is used for README grouping
|
|
- sessions
|
|
|
|
# ============================================================================
|
|
# OPTIONAL FIELDS
|
|
# ============================================================================
|
|
|
|
# Scope is often not relevant for standalone projects
|
|
# Include only if the project can be installed globally vs per-project
|
|
|
|
tags:
|
|
- dashboard
|
|
- monitoring
|
|
- web-ui
|
|
- analytics
|
|
|
|
min_version: "1.0.0"
|
|
|
|
homepage: https://example.com/opencode-dashboard
|
|
|
|
installation: |
|
|
## Prerequisites
|
|
- Node.js 18+
|
|
- OpenCode 1.0.0 or later
|
|
|
|
## Installation
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://github.com/example/opencode-dashboard
|
|
cd opencode-dashboard
|
|
|
|
# Install dependencies
|
|
npm install
|
|
|
|
# Start the dashboard
|
|
npm start
|
|
```
|
|
|
|
## Configuration
|
|
Create a `.env` file:
|
|
```bash
|
|
OPENCODE_LOG_DIR=~/.config/opencode/logs
|
|
PORT=3000
|
|
```
|
|
|
|
## Usage
|
|
Open `http://localhost:3000` in your browser.
|
|
|
|
## Docker (Alternative)
|
|
```bash
|
|
docker run -p 3000:3000 \
|
|
-v ~/.config/opencode:/opencode:ro \
|
|
example/opencode-dashboard
|
|
```
|