Repository Structure
| Language: 🇺🇸 English | 🇰🇷 í•œêµì–´ |
This document is the repository map split out of the root README. 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 |
| AGENTS.md | Project rules and runtime gate SSOT |
| 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 PowerShell installer entrypoint |
| 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/ | Canonical path for the session-intent-analyzer intent state producer |
| task-router/ | Internal core gate that derives capability routing |
| boundary-contract/ | Work boundary contract gate |
| coding-convention/ | Development workflow family |
| skill-catalog/ | Generated gate metadata used by the runtime |
Official Docs And Policies
| Path | Role |
|---|---|
| official-docs/derived/ | Ghost-ALICE analysis, philosophy, compliance, and closed-loop SSOT |
| docs/policies/ | Runtime, platform, and evaluator policy documents |
| docs/plans/ | Public roadmap policy and planning boundaries |
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 |
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 official-docs/derived.