# gptme - Doramagic AI Context Pack

> Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated.

## Project

- canonical_name: `gptme/gptme`
- capability: Your agent in your terminal, equipped with local tools: writes code, uses the terminal, browses the web. Make your own persistent autonomous agent on top!
- expected_user_outcome: Your agent in your terminal, equipped with local tools: writes code, uses the terminal, browses the web. Make your own persistent autonomous agent on top!

## Operating Boundaries

- Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it.
- Project facts must come from repo evidence, Claim Graph, or explicit source references.
- When a capability is not verified, mark it as unverified instead of completing it as fact.
- publish_status: `publishable`
- blocking_gaps: none

---

## Doramagic Context Augmentation

The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints.

## Human Manual Outline

Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph.

Host AI hard rules:
- Do not treat page titles, section order, summaries, or importance values as factual project evidence.
- When explaining the Human Manual outline, state that it is only a reading route or salience signal.
- Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph.

- **Project Overview and Architecture**: importance `high`
  - source_paths: README.md, pyproject.toml, gptme/__init__.py, gptme/__main__.py, gptme/cli/main.py
- **Tools, LLM Providers, and RAG**: importance `high`
  - source_paths: gptme/tools/__init__.py, gptme/tools/base.py, gptme/tools/patch.py, gptme/tools/patch_anchored.py, gptme/tools/shell.py
- **Server, Web UI, and Desktop**: importance `medium`
  - source_paths: gptme/server/__init__.py, gptme/server/app.py, gptme/server/api_v2.py, gptme/server/cli.py, gptme/server/session_models.py
- **Extensibility, Plugins, and Autonomous Agents**: importance `high`
  - source_paths: gptme/plugins/__init__.py, gptme/plugins/registry.py, gptme/plugins/entrypoints.py, gptme/hooks/__init__.py, gptme/hooks/registry.py

## Repo Inspection Evidence

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `7061f0bbc387baa0b1b8a8970e043087fea4303b`
- inspected_files: `README.md`, `docker-compose.yml`, `pyproject.toml`, `docs/agent/verifier-profile.md`, `docs/bot.md`, `docs/conf.py`, `docs/custom-providers.md`, `docs/design/elicitation.md`, `docs/design/hook-based-confirmations.md`, `docs/finetuning.md`, `docs/glossary.md`, `docs/howto/automate-task.md`, `docs/howto/code-review.md`, `docs/howto/debug-python.md`, `docs/howto/edit-files.md`, `docs/howto/index.md`, `docs/howto/minimal-context.md`, `docs/howto/refactor.md`, `docs/lessons/CONTRIBUTING.md`, `docs/lessons/EXAMPLES.md`

Host AI hard rules:
- Without repo_clone_verified=true, do not claim that the source code has been read.
- Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts.
- Without quick_start_verified=true, do not claim that the Quick Start path has run successfully.

## Doramagic Pitfall Constraints

These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes.

### Constraint 1: Security or permission risk requires verification

- Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/gptme/gptme/issues/2667
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 2: Installation risk requires verification

- Trigger: Developers should check this installation risk before relying on the project: v0.31.1.dev20260525
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.31.1.dev20260525. Context: Observed during installation or first-run setup.
- Why it matters: Upgrade or migration may change expected behavior: v0.31.1.dev20260525
- Evidence: failure_mode_cluster:github_release | https://github.com/gptme/gptme/releases/tag/v0.31.1.dev20260525
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 3: Installation risk requires verification

- Trigger: Developers should check this installation risk before relying on the project: v0.31.1.dev20260604
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.31.1.dev20260604. Context: Source discussion did not expose a precise runtime context.
- Why it matters: Upgrade or migration may change expected behavior: v0.31.1.dev20260604
- Evidence: failure_mode_cluster:github_release | https://github.com/gptme/gptme/releases/tag/v0.31.1.dev20260604
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 4: Installation risk requires verification

- Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/gptme/gptme/issues/2982
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 5: Configuration risk requires verification

- Trigger: Project evidence flags a configuration risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: capability.host_targets | https://github.com/gptme/gptme
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 6: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: feat(patch): add patch_anchored tool — hash-anchored editing with atomic verify-apply
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: feat(patch): add patch_anchored tool — hash-anchored editing with atomic verify-apply. Context: Source discussion did not expose a precise runtime context.
- Why it matters: Developers may misconfigure credentials, environment, or host setup: feat(patch): add patch_anchored tool — hash-anchored editing with atomic verify-apply
- Evidence: failure_mode_cluster:github_issue | https://github.com/gptme/gptme/issues/2667
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 7: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.31.1.dev20260504
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.31.1.dev20260504. Context: Observed during installation or first-run setup.
- Why it matters: Upgrade or migration may change expected behavior: v0.31.1.dev20260504
- Evidence: failure_mode_cluster:github_release | https://github.com/gptme/gptme/releases/tag/v0.31.1.dev20260504
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 8: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.31.1.dev20260511
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.31.1.dev20260511. Context: Source discussion did not expose a precise runtime context.
- Why it matters: Upgrade or migration may change expected behavior: v0.31.1.dev20260511
- Evidence: failure_mode_cluster:github_release | https://github.com/gptme/gptme/releases/tag/v0.31.1.dev20260511
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 9: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.31.1.dev20260518
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.31.1.dev20260518. Context: Observed during installation or first-run setup.
- Why it matters: Upgrade or migration may change expected behavior: v0.31.1.dev20260518
- Evidence: failure_mode_cluster:github_release | https://github.com/gptme/gptme/releases/tag/v0.31.1.dev20260518
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 10: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: v0.31.1.dev20260521
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.31.1.dev20260521. Context: Observed when using python, windows, macos
- Why it matters: Upgrade or migration may change expected behavior: v0.31.1.dev20260521
- Evidence: failure_mode_cluster:github_release | https://github.com/gptme/gptme/releases/tag/v0.31.1.dev20260521
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.
