mirror of
https://github.com/microsoft/SkillOpt.git
synced 2026-07-07 08:22:44 +08:00
b701d9b6d9
Per maintainer request: - Remove the internal/scratch docs/sleep/ tree (reports, raw logs, blog run JSON, sweep.jsonl) — 23 files — and the root PUBLISHING.md. These were working notes, not reference docs. - Take the dedicated SkillOpt-Sleep content out of the main README (News bullet + section) and host it in the rendered guide instead: new section 9 in docs/guideline.html (deployment companion, the three plugins, opt-in experience replay / dream rollouts) with a sidebar entry. - Fix the README's opening reference so "Documentation & Reproduction Guide" links directly to the rendered GitHub Pages page, not the raw .html source. - Repoint the now-removed docs/sleep links in the plugin READMEs to the guide section. The plugin code (plugins/, skillopt_sleep/) is unchanged; only docs move. Co-Authored-By: Claude Opus 4 <noreply@anthropic.com>
72 lines
3.1 KiB
Markdown
72 lines
3.1 KiB
Markdown
# SkillOpt-Sleep — Codex integration
|
|
|
|
Give your **Codex** agent a nightly **sleep cycle**: it reviews past sessions
|
|
offline, replays your recurring tasks on your own Codex budget, and consolidates
|
|
what it learns into validated memory + skills behind a held-out gate. Same engine
|
|
as the Claude Code plugin (`skillopt_sleep`), wrapped for Codex.
|
|
|
|
> **Verified on Codex:** on the public
|
|
> [gbrain-evals](https://github.com/garrytan/gbrain-evals) `skillopt-v1`
|
|
> benchmark, a deliberately deficient skill goes **0.00 → 1.00** on a held-out
|
|
> set with the Codex backend (incl. the tool-use seed via a real tool loop).
|
|
> See [the SkillOpt-Sleep guide section](https://microsoft.github.io/SkillOpt/docs/guideline.html#sleep).
|
|
|
|
## What Codex supports (and what we use)
|
|
|
|
Codex (`@openai/codex`) extends via **`AGENTS.md`** instructions, **skills** at
|
|
`~/.agents/skills/<name>/SKILL.md`, and plugins that can distribute skills.
|
|
Custom prompts are deprecated in Codex, so this integration is skill-first: the
|
|
installed `skillopt-sleep` skill contains the launch commands and operating
|
|
rules. The shared runner remains a plain shell entrypoint that the skill calls.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
git clone <repo-url> SkillOpt-Sleep
|
|
cd SkillOpt-Sleep
|
|
bash plugins/codex/install.sh # installs the skill
|
|
export SKILLOPT_SLEEP_REPO="$(pwd)" # so the runner is found from anywhere
|
|
```
|
|
|
|
If a previous install created `~/.codex/prompts/sleep.md`, the installer moves
|
|
that deprecated prompt aside with a `.skillopt-legacy*.bak` suffix.
|
|
|
|
Requires Python ≥ 3.10 and the `codex` CLI on PATH.
|
|
|
|
## Use
|
|
|
|
Mention `$skillopt-sleep` where Codex supports explicit skill mentions, or ask
|
|
Codex in natural language:
|
|
|
|
```text
|
|
Use the skillopt-sleep skill to run status for this project.
|
|
Use the skillopt-sleep skill to run a dry-run for this project.
|
|
Use the skillopt-sleep skill to run the full cycle for this project with the Codex backend.
|
|
Use the skillopt-sleep skill to adopt the latest staged proposal.
|
|
```
|
|
|
|
Or call the engine directly:
|
|
|
|
```bash
|
|
python -m skillopt_sleep dry-run --project "$(pwd)" --source codex --backend mock
|
|
python -m skillopt_sleep run --project "$(pwd)" --source codex --backend codex
|
|
```
|
|
|
|
`--source codex` reads Codex Desktop archived sessions from
|
|
`~/.codex/archived_sessions`. Use `--codex-home /path/to/.codex` to point at a
|
|
different Codex home, or `--source auto` to try Codex archives first and fall
|
|
back to Claude Code transcripts. Default backend is `mock` (no API spend).
|
|
`--backend codex` uses your Codex budget for real improvement. All the
|
|
controllable knobs (`--gate on|off`, `--rollouts-k`, `--budget-tokens`,
|
|
`--preferences`, optimizer/target split) work identically — see
|
|
[the SkillOpt-Sleep guide section](https://microsoft.github.io/SkillOpt/docs/guideline.html#sleep).
|
|
|
|
## Notes / status
|
|
|
|
- Codex's `exec` runs shell, so the real-tool-loop replay (e.g. the
|
|
`tool_called: search` benchmark seed) works natively.
|
|
- This integration no longer installs a `.codex/prompts` slash command. Skills
|
|
are the reusable Codex workflow surface; mention `skillopt-sleep` explicitly
|
|
or ask for a sleep/dream/offline self-improvement run and Codex can load the
|
|
skill.
|