README.md

OpenAgentPack Documentation

English files are the canonical source for behavior; translated files use a .zh-CN.md suffix and describe the same public contract. This index organizes documentation by what you want to do.

Getting started

Doc	What's inside
Getting started	Shortest path from install to a running session. (中文：getting-started.zh-CN.md)

Concepts

Mental model behind plan and apply — no field tables.

Doc	What's inside
Agents as code	Why a declarative agents.yaml instead of console clicks.
Resources	The resource types OpenAgentPack manages and their dependencies.
State and drift	The three sources of truth and how drift is reconciled.
Sessions and deployments	Infrastructure resources vs. runtime runs.

Guides

Task-oriented, with steps and verification.

Doc	What's inside
Configure an agent	Build an agents.yaml from minimal to full stack.
Deploy to Bailian	Bailian (Aliyun AgentStudio) setup and notes.
Deploy to Qoder	Qoder-specific setup and notes.
Use BYOC environments	Connect Qoder sessions to administrator-provisioned self-hosted environments and private-network tunnels.
Deploy to Claude	Claude-specific setup and notes.
Deploy to Volcengine Ark	Volcengine Ark (Managed Agents) setup and notes.
Use skills	Author and attach reusable capability modules.
Use MCP and vaults	Connect external tool servers and manage their credentials.
Multi-provider	Deploy the same agent to more than one provider.
Run sessions	Start runtime conversations from a managed agent.
Manage deployments	Scheduled / triggered runs and outcome rubrics.

Reference

Stable facts — fields, commands, provider matrix, API.

Doc	What's inside
Configuration reference	Every agents.yaml field: type, required, default, provider support.
CLI reference	Every agents command, options, and behavior.
Provider reference	Capability matrix and per-provider configuration.
SDK reference	Public @openagentpack/sdk API surface.
OpenAPI reference	The HTTP surface exposed by apps/server.

Architecture

For contributors and deep users.

Doc	What's inside
How it works	State management, dependency graph, incremental diffing.

Contributing

For external contributors.

Doc	What's inside
Contributing overview	Dev setup, merge requirements, code style.
Maintainer review	Evidence-based PR review and merge gates.
Development	Clone, install, run, test, package boundaries.
Provider development	The six files a new provider must implement.
Release	npm publishing workflow and Trusted Publishing.

Conventions

• Design briefs and trade-off notes under package-specific documentation describe implementation history and do not override the public contract above.
• Provider capability tables are verified against the SDK declarations by scripts/provider-docs.test.ts; the canonical matrix lives in Provider reference.