Skip to content

INDEX.md

Latest commit

 

History

History
91 lines (76 loc) · 4.45 KB

INDEX.md

File metadata and controls

91 lines (76 loc) · 4.45 KB
Raw

OpenCode Kit Index

Agent-owned navigation map for the shared OpenCode workspace.

When To Read This

  • Read this when starting work in the shared agent kit or when looking for the right command, rule, or skill file.
  • In this source repository and consuming repositories, opencode.json loads this as the repository-root INDEX.md.

Directory Map

  • ai-scripts/ - helper scripts used by shared commands and skills.
  • commands/ - reusable slash-command workflow definitions.
  • rules/ - durable instructions loaded by opencode.json.
  • skills/ - specialized workflows that can be loaded on demand.
  • docs/tasks/ - source-repository task guide and local implementation specs for accepted work.
  • docs/tasks/OVERVIEW.md - concise open-task list with dependencies and blockers.
  • .oc_local/opencode.json - source-only configuration that explicitly loads .oc_local/rules/*.md alongside the shared instructions.
  • .oc_local/rules/gitea-git.md - source-only Tea authentication and Git fetch/pull/push guidance for the internal Gitea remote.
  • .oc_local/rules/mcp-maintenance.md - check enabled MCP integrations for currency, maintenance, and connectivity during every /save.
  • .github/workflows/ci.yml - read-only contributor CI that runs task test.
  • opencode.json - runtime configuration that loads shared instructions, MCP servers, and permissions.
  • playwright-mcp.json - Playwright MCP browser launch configuration copied into the generated release bundle.
  • README.md - source-repository overview for maintainers.
  • CONTRIBUTING.md - generic-versus-local ownership and source contribution workflow.
  • README_release.md - source file copied to README.md on the generated release branch.
  • LICENSE - canonical 0BSD license copied into the generated release bundle.
  • Taskfile.yml - release-copy, release-build, and smoke-test entrypoints.
  • tests/release-copy.sh - smoke test for the generated release bundle.

Known Directory Indexes

  • INDEX.md - this root index in the repository root.

Key Workflows

  • Work on the current source branch; topic branches from main are optional and agents create them only on explicit user request. Keep the local task authoritative, use a GitHub mirror Issue only when public tracking is requested, and never implement changes in generated release or .opencode/ checkouts.
  • Use task test after changing documentation workflows, release runtime files, or release-copy behavior.
  • For source sessions, point OPENCODE_CONFIG_DIR at <repository-root>/.oc_local (already set by the devcontainer) and restart OpenCode after config changes.
  • Maintainers use .oc_local/commands/release-build.md for release review, changelog, authorization, publication, and final synchronization.
  • Use /task spec "<title/context>" and /task impl <task-ref> [instructions] for tracked task work; public Issues are optional, and creating one requires an explicit request plus approval of its exact preview. Existing linked Issues remain binding through completion.
  • Use /update-index <directory> to create or refresh directory-local indexes.
  • For the internal Gitea origin, follow .oc_local/rules/gitea-git.md; Tea supplies credentials while Git performs fetch, pull, and push.

Search Hints

  • RELEASE_PATHS - release bundle source paths in Taskfile.yml.
  • docs/tasks/README.md - GitHub mirror declaration plus Issue-to-task-to-PR linkage and status conventions.
  • LICENSE - 0BSD terms that must remain in source and release output.
  • playwright-mcp.json - browser config used by the shared Playwright MCP.
  • /update-index - command for creating or refreshing directory indexes.
  • GitHub Mirror, GH_TOKEN, spec, impl - task tracking and implementation workflow terms.
  • GITEA_TOKEN, tea login helper, git.codegeist.ai, sslVerify - internal source Git authentication and TLS troubleshooting.
  • directory-index.md - rule that defines the INDEX.md pattern.
  • instructions, OPENCODE_CONFIG_DIR - shared and source-local rule loading.

Update Triggers

  • Update this file when a new INDEX.md is added, moved, or removed.
  • Update this file when top-level directories, release paths, or major shared entrypoints change.

Agent Notes

  • Keep this index compact because it is loaded into OpenCode instructions.
  • Keep this file outside the .opencode release submodule while keeping LICENSE in that bundle. Consuming repositories own their root INDEX.md content.