# INSTALL

**This file is written for an agent.** If a user hands you this repository URL and says
"install this for me", follow it top to bottom. Humans can just read the
[README](README.md) instead.

- Repository: <https://github.com/SolarLLM/solar-proofread>
- What it is: an Agent Skill (`SKILL.md` at the repo root) plus one dependency-free Python
  script (`scripts/solar_proofread.py`, standard library only, Python 3.8+).
- What it needs at runtime: an OpenRouter API key in `~/.env`. **The user creates that key,
  not you** — see step 4.

## 1. Choose the install directory

| Host | Personal (every project) | Project-local |
|---|---|---|
| Claude Code | `~/.claude/skills/solar-proofread` | `<project>/.claude/skills/solar-proofread` |
| Codex CLI | `~/.codex/skills/solar-proofread` | `<project>/.agents/skills/solar-proofread` |
| Claude app (Cowork) | upload a `.skill` bundle — step 5 | — |

Default to the personal directory unless the user says they want it for one project only.
On Windows, `~` is `$env:USERPROFILE` (`C:\Users\<name>`).

## 2. Clone

macOS / Linux / WSL:

```bash
git clone https://github.com/SolarLLM/solar-proofread.git ~/.claude/skills/solar-proofread
```

Windows PowerShell:

```powershell
git clone https://github.com/SolarLLM/solar-proofread.git "$env:USERPROFILE\.claude\skills\solar-proofread"
```

If the directory already exists, update it instead of deleting the user's copy:
`git -C <dir> pull --ff-only`. If `git` is missing: `winget install Git.Git` on Windows,
`brew install git` on macOS, the distro package manager on Linux.

## 3. Verify the install

`SKILL.md` and `scripts/solar_proofread.py` must exist in the install directory. Then check
that Python can run the script:

```bash
python3 <dir>/scripts/solar_proofread.py --help
```

Windows: `py -3 "<dir>\scripts\solar_proofread.py" --help`

It should print the usage line. If Python is missing: `winget install Python.Python.3.12`
(Windows), `brew install python` (macOS). On Windows, `python` opening the Microsoft Store
means the App Execution Alias stub is in the way — install real Python or use `py`.

## 4. The API key — hand this step to the user

The skill needs an OpenRouter key. **Never ask the user to paste the key into the chat,
never write a guessed or placeholder key into `~/.env`, and never echo the value back.**

Check whether one is already configured — this prints only a yes/no:

```bash
grep -q '^OPENROUTER_API_KEY=' ~/.env && echo present || echo missing
```

```powershell
if (Select-String -Path "$env:USERPROFILE\.env" -Pattern '^OPENROUTER_API_KEY=' -Quiet) { "present" } else { "missing" }
```

If it is missing, tell the user to create a key at <https://openrouter.ai/keys>, add
credits at <https://openrouter.ai/credits>, and then run **one** of these themselves:

```bash
cat >> ~/.env << 'EOF'
OPENROUTER_API_KEY=sk-or-v1-PASTE_YOUR_KEY_HERE
SOLAR_MODEL=upstage/solar-pro4
EOF
chmod 600 ~/.env
```

```powershell
Add-Content -Path "$env:USERPROFILE\.env" -Encoding ascii -Value @(
  "OPENROUTER_API_KEY=sk-or-v1-PASTE_YOUR_KEY_HERE",
  "SOLAR_MODEL=upstage/solar-pro4"
)
icacls "$env:USERPROFILE\.env" /inheritance:r /grant:r "$($env:USERNAME):(R,W)"
```

`-Encoding ascii` matters on Windows PowerShell 5.1: the default UTF-8 write adds a BOM.
Then re-run the presence check above to confirm.

If the user is on **Cowork**, the key has to live in the cloud session's `~/.env`, not on
their laptop.

## 5. Cowork (Claude app) only

Cowork installs a bundle, not a clone:

```bash
git clone https://github.com/SolarLLM/solar-proofread.git
cd solar-proofread && rm -rf .git
cd .. && zip -Xr solar-proofread.skill solar-proofread
```

```powershell
git clone https://github.com/SolarLLM/solar-proofread.git
Remove-Item -Recurse -Force solar-proofread\.git
Compress-Archive -Path solar-proofread -DestinationPath solar-proofread.zip
Rename-Item solar-proofread.zip solar-proofread.skill
```

Tell the user to attach the `.skill` file in the chat window and save it.

## 6. Report back

Tell the user, in their language:

1. Where it was installed.
2. Whether the API key was found, and the exact command to run if it wasn't.
3. That the host picks the skill up on a **new session** (restart Codex if it doesn't
   appear).
4. How to trigger it: "Have Solar proofread this" / "Solar에게 교정 맡겨줘".