This repository provides a technical breakdown and tutorial for understanding the OpenCode project, an advanced open-source Coding Agent. It targets developers with prior experience in coding agents and programming languages who wish to learn the internal architecture and core concepts of agent development, including agents, tools, permissions, and session management, enabling them to build more comprehensive and controllable agents.

How It Works

The OpenCode architecture centers around an OpenCode Server that communicates with various clients (TUI, CLI, IDE, Web) via SDKs and protocols like SSE/WebSocket. A Session Engine manages the core execution loop, orchestrating Agents, Tools, and Permissions. It utilizes a Global Bus for inter-component communication and Provider Adapters to interface with different Large Language Models (LLMs). Key components include Agent Registry, Tool Registry, PermissionNext for access control, and LLM Orchestrator for model interaction.

Quick Start & Requirements

This is not a "from scratch" tutorial but a deep dive into the OpenCode project's architecture. Users are expected to have:

• Completed at least one project using a coding agent.
• Familiarity with at least one programming language.
• The tutorial requires pairing with the OpenCode source code for detailed understanding.
• Relevant links: OpenCode Official Website, OpenCode GitHub (Note: Actual URLs were not present in the provided text, placeholders used).

Highlighted Details

• Core Concepts: Comprehensive implementation of Agent, Tool, Permission, Skill, and Session (Context Engineering) for agent development.
• Architecture: Modular design featuring Session Engine, Agent/Tool Registries, Permission system, LLM Orchestrator, and Provider Adapters for multi-model support.
• Tooling: Over 20 built-in tools including file system operations, shell execution, web fetching/searching, and sub-agent task delegation.
• Extensibility: Skill system for specialized expert guidance and workflow integration via YAML-defined skills.

Maintenance & Community

Contributions are welcomed through bug reporting, adding practical examples, and improving documentation. The project links to its official website and GitHub repository for further engagement.

Licensing & Compatibility

The project is licensed under CC BY-NC 4.0 (Creative Commons Attribution-NonCommercial 4.0 International). This license prohibits commercial use and requires attribution.

Limitations & Caveats

This tutorial assumes existing familiarity with coding agents and programming; it is not an introductory guide. The CC BY-NC 4.0 license restricts commercial application and integration into proprietary systems. Specific setup time or resource footprint for the tutorial itself is not detailed.