Tura

Tura Repository

Tura is a Rust and TypeScript agent-runtime harness that executes model-planned command graphs while reducing repeated model round trips. Use this file to load only the repository documentation relevant to the current task.

Start Here

• Read README.md for the product overview and primary workflows; use README.zh-CN.md for the Chinese version.
• Read docs/README.md for the documentation entry point and docs/SUMMARY.md for the canonical user-documentation table of contents.
• Read ARCHITECTURE.md before changes that cross crates, processes, apps, command routing, prompts, or persistence boundaries.
• Consult ROADMAP.md, docs/KNOWN_ISSUES.md, and CHANGELOG.md when evaluating intended scope, known gaps, or released behavior.

Route by Task

Installation, configuration, and usage

• Overview
• Install and uninstall
• Release packages
• Providers
• How to start
• CLI parameters
• Settings
• Sessions
• Documentation navigation
• GUI settings
• TUI settings

Runtime concepts and user-facing behavior

• Task status
• Context management
• Runtime prompt
• Command run
• Commands
• Agents
• Personas
• HTML rich text
• Prompt style and dynamic injection

Customization

• Custom providers
• Custom personas
• Custom agents
• Custom runtime prompts
• Custom commands

Component architecture

• Agents: agents/ARCHITECTURE.md
• Personas: personas/ARCHITECTURE.md
• GUI: apps/gui/README.md, apps/gui/ARCHITECTURE.md, and gateway adjustment notes
• TUI: apps/tui/README.md and apps/tui/ARCHITECTURE.md
• Tauri shell: apps/tauri/README.md
• Gateway: crates/gateway/ARCHITECTURE.md
• Router: crates/router/README.md and crates/router/ARCHITECTURE.md
• Runtime: crates/runtime/ARCHITECTURE.md
• Provider layer: crates/provider/ARCHITECTURE.md
• Tools: crates/tools/ARCHITECTURE.md
• Session log: crates/session_log/README.md and crates/session_log/ARCHITECTURE.md
• Paths and process hardening: crates/path/ARCHITECTURE.md
• Build and maintenance scripts: scripts/ARCHITECTURE.md

Testing and contribution

Read tests/README.md before choosing or adding a test. Test classes are peers with different isolation, cost, and external-dependency rules:

• Business tests
• Backend end-to-end tests
• OS tests
• Live tests
• Release tests
• Runtime/session equivalence gate
• Behavior-test quality gate

For contribution conventions, read docs/contributing-guide.md. architect.md records the behavior-test refactor plan and is relevant only to that migration.

Prompt implementation sources

Read the runtime-prompt guide, the prompt-style guide, and the owning component architecture before editing prompt text. The main checked-in prompt sources are:

• Agent modes: balanced, direct, and direct text only
• Persona and communication styles: Tura, Pidan, Wonderful, communication, and CLI communication
• Built-in commands: generate media, read media, and web discover
• Tool commands: apply patch, bash, planning, shell command, task status, and zsh
• Runtime manuals: data research, debug, DevOps, editorial, frontend, interactive and 3D, new build, refactoring, visual, and website

Historical and Project Context

• Release notes: 0.1.34 and 0.1.35
• Project rationale: Why I am building Tura
• Benchmark and engineering context: MCP workflow benchmark lessons, benchmark data and test reports, token-saving plugin analysis, and GPT-5.6 Sol Max evaluation
• Contribution overview: How to contribute to Tura
• Funding and incubation tracking: funding-application-tracker.md

Working Rules

• Treat the root and component architecture documents as the source of truth for ownership and boundaries; confirm behavior in code when documentation and implementation differ.
• Keep user-facing documentation aligned with behavior changes. Update both language variants when a change affects claims or instructions shared by the English and Chinese root READMEs.
• Use the test class required by tests/README.md; do not collapse process-owning, live, performance, release, and local business coverage into one runner.
• Do not treat Markdown under node_modules, generated output, logs, sessions, or captured external npm research as repository instructions.