Repository Structure
| 언어: 🇺🇸 English | 🇰🇷 한국어 |
This document is the repository map. The README stays a concise public entry point; this page carries the detailed structure.
Contents
- Top-Level Documents
- Installer And Platforms
- Shared Utilities
- Core Governance And Runtime Gates
- Official Docs And Policies
- Installed Runtime State
- Documentation Responsibility
Top-Level Documents
| Path | Role |
|---|---|
| README.md | Concise public entry point and documentation hub |
| README_ko.md | Korean paired public entry point |
| architecture.md, architecture_ko.md | Paired Core responsibility and data-flow map |
| AGENTS.md | Project loader for the current host contract |
| Common governance | Shared contract source composed with host-specific rules |
| CLAUDE.md | Claude Code project rule entrypoint |
| docs/index.html | GitHub Pages homepage |
Installer And Platforms
| Path | Role |
|---|---|
| install.sh | macOS, Linux, WSL, and Git Bash installer entrypoint |
| install.ps1 | Windows installer entrypoint for PowerShell 7.6 or newer |
| install.cmd | Windows CMD wrapper |
| platforms/codex/ | Codex bootstrap source |
| hooks/ | Repository hook-related files |
For the full installer architecture, read installer architecture.
Shared Utilities
| Path | Role |
|---|---|
| _shared/ | Helpers shared by installers and skills |
| _shared/secrets/ | External credential lookup helpers |
| _shared/mcp/ | MCP installation helpers |
| scripts/ | Catalog, validation, installer compatibility, and public surface verification scripts |
Core Governance And Runtime Gates
| Path | Role |
|---|---|
| session-intent-analyzer/ | Records compressed user-intent facts and decisions through the session intake procedure |
| task-router/ | Consumes exact session intent and selects current work and skills |
| boundary-contract/ | Work boundary contract gate |
| coding-convention/ | Development workflow family |
| skill-catalog/ | Generated gate metadata used by the runtime |
| _shared/native_completion.py | Single Core assessment consumed by the completion guard and Ghost-ALICE Autopilot |
| _shared/original_claim_evidence.py | Authenticates retained claim bindings against current criteria and dependencies |
Official Docs And Policies
| Path | Role |
|---|---|
| official-docs/derived/ | Public contributor compliance procedures; long-form philosophy lives in the Wiki |
| docs/policies/ | Runtime, platform, and evaluator policy documents |
Installed Runtime State
These paths live outside the repository under the user’s home directory.
| Path | Role |
|---|---|
~/.ghost-alice/install-state/ |
Platform install-state manifests |
~/.ghost-alice/pending-merges/ |
Protected queue for user-modified installed files |
~/.ghost-alice/uninstall-reports/ |
Uninstall reports |
~/.ghost-alice/secrets.env |
Standard credential helper storage |
~/.agents/skills/ |
Codex user skill copy install target |
~/.claude/skills/ |
Claude Code skill install target |
The platform installation supplies common governance for every project. The Codex managed loader names ~/.codex/ghost-alice-governance.md; Claude’s managed global CLAUDE.md contains the common contract. Project instruction files supply project-specific constraints. The installation guide describes the source, installation and model handoffs. Runtime session state is authoritative in .tmp/session-intent/ghost-state.sqlite3 at the receipt’s repository root; JSON pointers and snapshots are compatibility/export material. Read state through session_intent_ledger.py --read-state with the receipt root, platform and session identity.
Documentation Responsibility
- README holds the public description and quick start only.
- Detailed installation and update guidance lives in installation guide.
- Contributor-facing installer flow and safety model live in installer architecture.
- Policy and runtime matrices live in docs/policies.
- Long-form philosophy and closed-loop reasoning live in the Wiki; official-docs/derived holds public contributor procedures.