|
| 1 | +# PAI-OpenCode Installer |
| 2 | + |
| 3 | +> GUI and CLI installer for PAI-OpenCode v3.0 |
| 4 | +
|
| 5 | +## Quick Start |
| 6 | + |
| 7 | +```bash |
| 8 | +# Run the installer |
| 9 | +bash PAI-Install/install.sh |
| 10 | +``` |
| 11 | + |
| 12 | +## What This Installer Does |
| 13 | + |
| 14 | +1. **Detects** your environment (macOS/Linux) |
| 15 | +2. **Installs** Bun runtime if not present |
| 16 | +3. **Creates** `~/.opencode/` directory structure |
| 17 | +4. **Copies** PAI core files (skills, plugins, handlers) |
| 18 | +5. **Configures** `opencode.json` with Model Tiers |
| 19 | +6. **Sets up** the Electron GUI (optional) |
| 20 | + |
| 21 | +## Directory Structure |
| 22 | + |
| 23 | +``` |
| 24 | +PAI-Install/ |
| 25 | +├── install.sh # Main bootstrap script |
| 26 | +├── main.ts # TypeScript entry point |
| 27 | +├── generate-welcome.ts # Welcome screen generator |
| 28 | +├── cli/ # CLI installer module |
| 29 | +│ ├── index.ts |
| 30 | +│ ├── display.ts |
| 31 | +│ └── prompts.ts |
| 32 | +├── engine/ # Install engine |
| 33 | +│ ├── index.ts |
| 34 | +│ ├── actions.ts |
| 35 | +│ ├── config-gen.ts |
| 36 | +│ ├── detect.ts |
| 37 | +│ ├── state.ts |
| 38 | +│ ├── steps.ts |
| 39 | +│ ├── types.ts |
| 40 | +│ └── validate.ts |
| 41 | +├── electron/ # Electron GUI app |
| 42 | +│ ├── main.js |
| 43 | +│ ├── package.json |
| 44 | +│ └── package-lock.json |
| 45 | +├── web/ # Web UI for Electron |
| 46 | +│ ├── server.ts |
| 47 | +│ └── routes.ts |
| 48 | +└── public/ # Static assets |
| 49 | + ├── index.html |
| 50 | + ├── styles.css |
| 51 | + ├── app.js |
| 52 | + └── assets/ |
| 53 | + ├── pai-logo.png |
| 54 | + ├── banner.png |
| 55 | + ├── fonts/ |
| 56 | + └── audio/ |
| 57 | +``` |
| 58 | + |
| 59 | +## Installation Modes |
| 60 | + |
| 61 | +### CLI Mode (Default) |
| 62 | +Terminal-based interactive installation. |
| 63 | + |
| 64 | +### GUI Mode |
| 65 | +```bash |
| 66 | +bash PAI-Install/install.sh --gui |
| 67 | +``` |
| 68 | +Launches Electron installer with visual step-by-step setup. |
| 69 | + |
| 70 | +## Post-Installation |
| 71 | + |
| 72 | +After installation, you'll have: |
| 73 | + |
| 74 | +- `~/.opencode/skills/` — PAI skills and tools |
| 75 | +- `~/.opencode/plugins/` — Event handlers |
| 76 | +- `~/.opencode/commands/` — Custom OpenCode commands |
| 77 | +- `~/.opencode/MEMORY/` — Working memory and state |
| 78 | +- `~opencode.json` — Configuration with Model Tiers |
| 79 | + |
| 80 | +## Upgrade from v2.x |
| 81 | + |
| 82 | +See [UPGRADE.md](/UPGRADE.md) for migration instructions. |
| 83 | + |
| 84 | +## Troubleshooting |
| 85 | + |
| 86 | +| Issue | Solution | |
| 87 | +|-------|----------| |
| 88 | +| Bun not found | Installer will auto-install Bun | |
| 89 | +| Permission denied | Run with `bash` not `sh` | |
| 90 | +| Electron fails | Use CLI mode: `install.sh --cli` | |
| 91 | + |
| 92 | +## Requirements |
| 93 | + |
| 94 | +- macOS 10.15+ or Linux |
| 95 | +- bash 4.0+ |
| 96 | +- curl |
| 97 | +- 500MB free disk space |
| 98 | + |
| 99 | +--- |
| 100 | + |
| 101 | +*Part of PAI-OpenCode v3.0 — Personal AI Infrastructure* |
0 commit comments