# Project documentation OMGCode has a Rust CLI prototype for local chat, JSONL sessions, and a bounded native workspace file broker. The broker is available only through trusted operator commands and, when a workspace enables `model_tools`, to the local model's read, list, and approval-gated command tools. Model write, network, Git, and MCP tools are not implemented. The trusted CLI `run` command runs one program under Linux Landlock or Windows AppContainer confinement with an operator-declared toolchain profile. No model tool starts a process. The guides distinguish implemented behaviour from the remaining product contracts. ## Start here 1. Read the root [contributor guidance](../AGENTS.md). 2. Read the [coding rules](coding-rules.md) before code or test work. 3. Follow the [security rules](security-coding-rules.md) and [testing standards](testing-standards.md). 4. Check the [platform targets](platform-support.md) for platform-specific work. ## Document owners | Document | Purpose | | --- | --- | | [Project overview](../README.md) | Product scope, proposed architecture, and roadmap | | [Implementation plan](../IMPLEMENTATION_PLAN.md) | Resumable baseline, phase order, acceptance criteria, and resume commands | | [Build and run](development.md) | Current CLI, build commands, crate boundaries, limits, and dependencies | | [Coding rules](coding-rules.md) | Rust design, ownership, errors, concurrency, and workflow | | [Security coding rules](security-coding-rules.md) | Permission, sandbox, credential, Git, and UI boundaries | | [Testing standards](testing-standards.md) | Test design, execution, and evidence requirements | | [Platform support](platform-support.md) | Windows/Linux targets and the evidence needed for support | | [Provider authentication](provider-authentication.md) | Required subscription/API profiles, provider evidence, and readiness gates | | [Workspace settings](workspace-permissions.md) | Implemented workspace IDs, configuration-only permissions, revisions, audit, and remaining gates | | [Workspace file access](file-access.md) | Native broker, previews, Linux ext4 apply, checkpoint storage, and existing-only recovery | | [Development tools](development-tools.md) | Installed/managed toolchains, runtime grants, outputs, caches, and qualification | | [Command execution](execution.md) | Process-tree runner contract, confinement, trusted runs, toolchain profiles, the run journal, limits, and next increments | | [Agent instructions](agent-instructions.md) | Product priorities, visible SYSTEM prompt, user additions, and request manifests | | [System prompt draft](../prompts/system.md) | Versioned initial base instructions for the coding assistant | | [Context management](context-management.md) | Token-based compaction, cache classes, invalidation, and efficiency measures | | [Skills](skills.md) | Settings, package validation, enablement, loading, and controlled scripts | | [Bundled skill sources](../skills/README.md) | Source-only packages and provenance; runtime loading remains planned | | [MCP support](mcp.md) | Server connections, transports, credentials, capabilities, and tool authorization | | [Session storage](session-storage.md) | JSONL layout/schema, tool events, durable journals, archive/restore, and safe resume | | [Memories](memories.md) | User-selected project/global scope, management, retrieval, and lifecycle | | [Repository checks](repository-checks.md) | CodeRabbit, CodeQL, Sonar, credentials, and main protection | | [ADR register](adr/index.md) | Lasting decisions, alternatives, and consequences | | [Changelog](../CHANGELOG.md) | Changes awaiting release | ## Updates required with a change | Change | Update | | --- | --- | | Any repository change | Changelog and the relevant owning guide | | A coding convention | Coding rules; an ADR when the choice needs lasting rationale | | A security property, permission, or trust boundary | Security coding rules and relevant tests | | A test convention or verification command | Testing standards | | Repository analysis, CI workflows, or branch rules | Repository checks and relevant testing/security guidance | | Workspace identity, settings, revisions, or policy audit | Workspace settings, session storage, security rules, and relevant tests | | Workspace file broker, native file boundary, or uncertain creation | Workspace file access, platform support, security rules, session storage, and relevant tests | | A supported platform or prerequisite | Platform support | | Provider login, subscription entitlement, or billing | Provider authentication and security rules | | Tool discovery, runtime access, build environments, or build/package caches | Development tools and platform support | | Prompt text, user additions, or instruction assembly | Agent instructions, prompt draft, and security rules | | Model context, compaction, or LLM artifact caching | Context management, security rules, and testing standards | | Skills, imports, enablement, or skill resources | Skills, agent instructions, and relevant security/testing guidance | | MCP connections, tools, resources, prompts, or client capabilities | MCP, security rules, and testing standards | | Session format, persistence, archives, restore, or resume | Session storage, security rules, and testing standards | | Memory saving, scope, retrieval, deletion, or reuse | Memories, agent instructions, context management, and security/testing guidance | | Product scope or the proposed architecture | Root README | | Project implementation status or module guidance | Root AGENTS.md and relevant directory guidance | | A lasting decision with a plausible alternative | New ADR and register entry | | A new document | This index, or its owning sub-index | Keep each rule in one owning guide and link to it elsewhere. Use the ADRs for rationale rather than duplicating full policy text. Do not create a new document for each implementation task or temporary investigation. Use Markdown headings, fenced code blocks with language tags, and relative links for repository files. Keep whitespace clean and end files with a newline. ## Current enforcement status Repository review and analysis are configured in the repository-checks guide. The Rust workflow adds formatting, strict Clippy, unit/integration tests, and separate documentation tests on Windows and Linux. The development guide owns the current commands and limits. There is no frontend yet. The trusted `run` command uses native confinement that was tested on one Windows build and one Linux kernel only. Every trusted run has memory, process-count, CPU-time, and sampled net disk-growth limits; the disk limit is not a filesystem quota. Package-network profiles are recorded as configuration only (ADR-0034); no run uses them, and network access remains all-or-nothing. The trusted `packages fetch` command downloads from declared origins into a per-workspace cache. A selected root is exposed read-only on Linux and Windows; Windows needs a read-execute grant, and Linux falls back to application storage. Provider profiles record connection shapes, and approval records prepare per-call model-tool consent; neither enables an adapter or model tool. The limited file broker and the core read/list turn runtime do not provide general model tools. Chat dispatches only the read and list tools, and only for a workspace that enables `model_tools`. A read-only CLI preview compares a workspace file with trusted proposed content without writing to the workspace or creating a checkpoint. Dependency security audits, native containment qualification, and release checks still need their own implementation and evidence.