Installation And Update Guide
| Language: English | Korean |
This guide is the command reference for installing, updating, checking, and repairing Ghost-ALICE OS. Public guidance uses OS-native entrypoints with the same long flag surface.
- macOS, Linux, WSL, or Git Bash:
bash install.sh ... - Windows Command Prompt or PowerShell:
.\install.cmd ...
On Windows, install.cmd keeps the native wrapper path, Python 3.11+
installer contract, UTF-8 console setup, and -NoProfile -ExecutionPolicy Bypass.
This handles PowerShell execution policy blocks and does not change the user or machine execution policy.
Contents
- Quick Install
- Install Official Addons
- Official Addon List
- Install One Official Addon To One Platform
- Install Custom Addons
- Install One Platform
- Check Status
- Update
- Common Commands
- Runtime And Platform Reference
- Uninstall
- Troubleshooting
Quick Install
macOS, Linux, WSL, or Git Bash:
git clone https://github.com/AidALL/ghost-alice.git ~/ghost-alice
cd ~/ghost-alice
bash install.sh
Windows Command Prompt or PowerShell:
git clone https://github.com/AidALL/ghost-alice.git %USERPROFILE%\ghost-alice
cd %USERPROFILE%\ghost-alice
.\install.cmd
Install Official Addons
Official addons use short aliases and install from the Ghost-ALICE core checkout.
macOS, Linux, WSL, or Git Bash:
bash install.sh --addon autopilot
Windows Command Prompt or PowerShell:
.\install.cmd --addon autopilot
Windows Command Prompt and PowerShell use the same official alias through
.\install.cmd --addon autopilot.
Run this from the Ghost-ALICE core checkout. Normal users do not clone the
autopilot addon repository or run an installer inside that repository; the core
installer fetches the official addon package. This install example is not a full runtime compatibility claim; read the addon repository compatibility-matrix.json
before making one.
To install the official addon for one platform only, add --platform:
bash install.sh --platform codex --addon autopilot
.\install.cmd --platform codex --addon autopilot
Addon-specific behavior, state files, pause/resume controls, and removal details live in each addon repository. The core checkout owns the common install command.
Official Addon List
| Addon | Purpose | macOS / Linux / WSL | Windows Command Prompt / PowerShell | Details |
|---|---|---|---|---|
| autopilot | Continue explicitly approved autonomous runs one work item at a time | bash install.sh --addon autopilot |
.\install.cmd --addon autopilot |
AidALL/ghost-alice-autopilot |
Install One Official Addon To One Platform
bash install.sh --platform codex --addon autopilot
.\install.cmd --platform codex --addon autopilot
Install Custom Addons
Custom, tenant, or local development addons use --addon-source PATH|URL.
bash install.sh --addon-source /path/to/addon-repo
.\install.cmd --addon-source C:\path\to\addon-repo
For git URL addon sources, --addon-tag selects the branch or tag to clone into
the local addon source cache.
Install One Platform
| Target | macOS / Linux / WSL | Windows Command Prompt / PowerShell |
|---|---|---|
| Claude Code | bash install.sh --platform claude |
.\install.cmd --platform claude |
| Codex | bash install.sh --platform codex |
.\install.cmd --platform codex |
To choose interactively:
bash install.sh --prompt-platform
.\install.cmd --prompt-platform
Check Status
Doctor is a read-only strict diagnostic. Use it before changing a suspicious install.
bash install.sh --doctor
bash install.sh --status
.\install.cmd --doctor
.\install.cmd --status
The healthy target is overall: ok.
Update
Update the local clone through the installer so source-local edits are stashed before a fast-forward.
cd ~/ghost-alice
bash install.sh --update-source
cd %USERPROFILE%\ghost-alice
.\install.cmd --update-source
If the checkout is too old to receive that option because raw git pull is
already blocked by local changes, use the bootstrap updater.
cd ~/ghost-alice && git fetch origin main && git show FETCH_HEAD:scripts/bootstrap-source-update.sh | /bin/bash -s --
If source update stops with conflicts, divergent branches, or non-fast-forward state, do not rerun the installer repeatedly. Follow troubleshooting first.
Then rerun the installer.
bash install.sh
bash install.sh --doctor
bash install.sh --status
.\install.cmd
.\install.cmd --doctor
.\install.cmd --status
Common Commands
| Purpose | macOS / Linux / WSL | Windows Command Prompt / PowerShell |
|---|---|---|
| List skills | bash install.sh --list |
.\install.cmd --list |
| Show install state | bash install.sh --status |
.\install.cmd --status |
| Run protected diagnostic | bash install.sh --doctor |
.\install.cmd --doctor |
| Safe source update | bash install.sh --update-source |
.\install.cmd --update-source |
| Install official autopilot addon | bash install.sh --addon autopilot |
.\install.cmd --addon autopilot |
| Install custom addon source | bash install.sh --addon-source /path/to/addon-repo |
.\install.cmd --addon-source C:\path\to\addon-repo |
| Selective core install | bash install.sh task-router verification-before-completion |
.\install.cmd task-router verification-before-completion |
| Full uninstall | bash install.sh --uninstall |
.\install.cmd --uninstall |
| Selective uninstall | bash install.sh --platform codex --uninstall task-router |
.\install.cmd --platform codex --uninstall task-router |
| Clean false pending entries | bash install.sh --platform claude --cleanup-pending |
.\install.cmd --platform claude --cleanup-pending |
Runtime And Platform Reference
Agent Visibility Profile
The default profile is dynamic. The profile controls how much governance
surface is shown to the user; it does not disable hooks, strict-grade logs, or
Work-Impact Projection.
| Profile | macOS / Linux / WSL | Windows Command Prompt / PowerShell |
|---|---|---|
| strict | bash install.sh --visibility strict |
.\install.cmd --visibility strict |
| dynamic | bash install.sh --visibility dynamic |
.\install.cmd --visibility dynamic |
| minimal | bash install.sh --visibility minimal |
.\install.cmd --visibility minimal |
--agent-visibility remains an accepted compatibility alias. Prefer
--visibility in new docs and commands.
Slash Commands By Platform
Claude Code treats slash commands as a first-class feature. Codex supports
built-in slash commands and a custom prompt path, but stable Ghost-ALICE profile
changes should use _shared/agent_visibility_cli.py when a trusted runtime
command is not available.
Python Contract
The installer requires Python 3.11 or newer. If Python 3.11+ is missing, it attempts automatic preparation where possible.
- macOS: if Homebrew is available,
brew install python3 - Linux / WSL: available package managers such as
apt-get,dnf,yum, orpacman - Windows:
winget,choco, thenscoop
If Python 3.11+ is still unavailable, installation stops and prints manual recovery guidance.
Node.js Contract
Claude Code and Codex hook-enabled installs require Node.js on PATH because
the tool-checkpoint PreToolUse gate runs ghost-alice-hook.mjs. The installer
blocks hook installation when the target platform is present but node is
unavailable.
Platform Update Behavior
| Platform | OS | Install mode | Install path | Skill body updates auto-reflect |
|---|---|---|---|---|
| Claude Code | macOS / Linux / WSL | symlink | ~/.claude/skills/ |
yes |
| Claude Code | Windows | junction | ~/.claude/skills/ |
yes |
| Codex | macOS / Linux / WSL | copy | ~/.agents/skills/ |
no |
| Codex | Windows | copy | ~/.agents/skills/ |
no |
| All platforms | Git Bash on Windows | copy fallback | varies | no |
Auto-reflection applies to skill bodies such as SKILL.md, references/, and
scripts/. Hooks, bootstrap files, permission policy, and _shared/ are
installer-managed runtime surfaces, so rerun the installer when they change.
Installed Surfaces
A full install deploys:
- core skills from
skill-catalog/skills.json - coding-convention workflow skills
- optional addon skills through official
--addonaliases or custom--addon-source _shared/utilities- platform hook settings
- Node-backed hook dispatcher assets under
~/.ghost-alice/hooks/ - Claude Code permission allowlist
- Codex
~/.codex/AGENTS.mdbootstrap - support state for install-state, pending merges, install rollbacks, and uninstall reports
merge-companion
When an update detects user-modified installed files, the installer isolates those candidates in a pending merge queue.
- manifest:
~/.ghost-alice/pending-merges/<platform>/manifest.json - backup:
~/.ghost-alice/pending-merges/<platform>/ - install state:
~/.ghost-alice/install-state/<platform>.json
On the next Claude/Codex session, if pending entries exist, merge-companion
asks whether each should be merged, discarded, or deferred.
Uninstall
Uninstall uses the installer-owned install-state manifest.
bash install.sh --uninstall
.\install.cmd --uninstall
See uninstall cleanup for the full cleanup contract.
Troubleshooting
When an update is blocked during git pull, a merge conflict, or an installer
rerun, start with troubleshooting.
The same recovery playbook is mirrored in the GitHub Wiki
install-troubleshooting page for people who cannot pull the repo yet.