copaw_source_index

CoPaw Documentation and Source Code Quick Reference

When answering installation, configuration, behavior principles type questions, first categorize by keyword, then according to the table below open the 1-2 most likely matching paths to read, avoiding lengthy aimless traversal.

Usage Steps

1. Extract the topic from the user's question (compare against the left column of the table below or similar terms).
2. Parse $COPAW_ROOT: obtain the executable path with which copaw ; if it is …/.copaw/bin/copaw , then the source root is the directory three levels above it (consistent with the guidance skill); otherwise determine it based on the installation path provided by the user.
3. Read the documentation first website/public/docs/<专题>.<语言>.md(choose the language consistent with the user:zh / en / ru , etc.), and if still insufficient, then read the source code entry points。

Topic / Keyword → Priority Documentation and Source Code

Topic or Keyword (Example)	Priority Documentation (website/public/docs/）	Common Source Code Entry Points (Relative to $COPAW_ROOT）
Installation, dependencies, first use	quickstart、intro	src/copaw/cli/、pyproject.toml
Configuration, config.json, environment variables	config	src/copaw/config/config.py、src/copaw/constant.py
Skills, SKILL, skill_pool, built-in skills	skills	src/copaw/agents/skills_manager.py、src/copaw/agents/skills/
MCP, plugins	mcp	src/copaw/app/routers/(grep as needed mcp）
Multi-agent, workspace, agent, built-in QA	multi-agent	src/copaw/app/routers/agents.py、src/copaw/app/migration.py、src/copaw/constant.py（BUILTIN_QA_AGENT_ID , etc.)
Memory, MEMORY, memory_search	memory	src/copaw/agents/memory/memory_manager.py、src/copaw/agents/tools/memory_search.py
Console, frontend	console	console/
Command line, subcommands, init	cli	src/copaw/cli/(such as init_cmd.py）
Channels, sessions	channels	under src/copaw search by channels keyword
Context, window	context	config documentation + src/copaw/agents/ related logic
Model, API Key	models	src/copaw/config/config.py
Heartbeat, HEARTBEAT	heartbeat	under src/copaw search heartbeat / HEARTBEAT
Desktop client	desktop	desktop/(if present in the repository)
Security	security	Read first security.<lang>.md
Errors, common issues	faq	First faq.<lang>.md, then look at the source code as needed
Commands and slash directives	commands	src/copaw modules related to CLI/command registration under (search as needed)

Conventions

• Full documentation path:$COPAW_ROOT/website/public/docs/<专题>.<语言>.md(when there is no corresponding language, use .en.md as a fallback).
• In the table, source code entry points are starting points; use read_file or local grep to narrow down to specific symbols; do not read through a large directory listing all at once.

Note

• This skill does not replace read_file: after locking down candidate paths, you should immediately read and verify them.
• If a path does not exist locally (for example, an installation tree without source code), use the installed documentation package or the root directory provided by the user as the basis, and clearly state the basis path.