JustinTX's picture
Add files using upload-large-folder tool
d7b3a74 verified

Agentic Usage Guide

This guide shows how to run Shinka with coding agents using the project skills:

  • shinka-setup: scaffold task files (evaluate.py, initial.<ext>, optional run config)
  • shinka-run: launch and iterate evolution batches via shinka_run
  • shinka-inspect: load top-performing programs into a compact context bundle

It covers:

  • installing Shinka
  • installing Claude Code and/or Codex CLI
  • copying skill files to the right skill directories
  • running a practical setup -> run -> inspect loop

1) Install Shinka

From a clean machine:

git clone https://github.com/SakanaAI/ShinkaEvolve.git
cd ShinkaEvolve

uv venv --python 3.11
source .venv/bin/activate
uv pip install -e .

Set API keys (example):

cp .env.example .env 2>/dev/null || true
# Edit .env and add OPENAI_API_KEY / ANTHROPIC_API_KEY as needed

2) Install Agent CLI(s)

Install one or both.

Claude Code

npm install -g @anthropic-ai/claude-code
claude --version

Codex CLI

npm install -g @openai/codex
codex --version

3) Copy Skills to Agent Skill Folders

Skill source files in this repo:

  • skills/shinka-setup/SKILL.md
  • skills/shinka-run/SKILL.md
  • skills/shinka-inspect/SKILL.md
  • optional helper scripts for setup skill:
    • skills/shinka-setup/scripts/run_evo.py
    • skills/shinka-setup/scripts/shinka.yaml
  • helper script for inspect skill:
    • skills/shinka-inspect/scripts/inspect_best_programs.py

Claude Code skill path

mkdir -p ~/.claude/skills/shinka-setup ~/.claude/skills/shinka-run ~/.claude/skills/shinka-inspect
cp skills/shinka-setup/SKILL.md ~/.claude/skills/shinka-setup/SKILL.md
cp -R skills/shinka-setup/scripts ~/.claude/skills/shinka-setup/
cp skills/shinka-run/SKILL.md ~/.claude/skills/shinka-run/SKILL.md
cp skills/shinka-inspect/SKILL.md ~/.claude/skills/shinka-inspect/SKILL.md
cp -R skills/shinka-inspect/scripts ~/.claude/skills/shinka-inspect/

Codex skill path

mkdir -p ~/.codex/skills/shinka-setup ~/.codex/skills/shinka-run ~/.codex/skills/shinka-inspect
cp skills/shinka-setup/SKILL.md ~/.codex/skills/shinka-setup/SKILL.md
cp -R skills/shinka-setup/scripts ~/.codex/skills/shinka-setup/
cp skills/shinka-run/SKILL.md ~/.codex/skills/shinka-run/SKILL.md
cp skills/shinka-inspect/SKILL.md ~/.codex/skills/shinka-inspect/SKILL.md
cp -R skills/shinka-inspect/scripts ~/.codex/skills/shinka-inspect/

4) Setup Skill Walkthrough (shinka-setup)

Ask the agent to scaffold a new task directory and evaluator contract.

Example prompt:

Use shinka-setup to scaffold a new task in examples/my_task.
Language: python.
Goal: maximize <metric>.

Illustration (setup flow):

Claude setup step 1

Claude setup step 2

Expected output:

  • initial.<ext> with evolve block
  • evaluate.py producing metrics.json + correct.json
  • optional run_evo.py / shinka.yaml scaffolds when requested

5) Run Skill Walkthrough (shinka-run)

Use shinka_run for agent-driven evolution loops.

Minimal batch:

shinka_run \
  --task-dir examples/my_task \
  --results_dir results/my_task_agent \
  --num_generations 10

With core knobs via --set:

shinka_run \
  --task-dir examples/my_task \
  --results_dir results/my_task_agent \
  --num_generations 20 \
  --set evo.max_api_costs=0.5 \
  --set evo.llm_models='["gpt-5-mini","gpt-5-nano"]' \
  --set db.num_islands=3 \
  --set db.parent_selection_strategy=weighted

Illustration (run flow):

Claude run step 1

Claude run step 2

6) Inspect Skill Walkthrough (shinka-inspect)

Use shinka-inspect after one or more batches to generate an agent-ready context file.

Minimal:

python skills/shinka-inspect/scripts/inspect_best_programs.py \
  --results-dir results/my_task_agent \
  --k 5

With filters and explicit output:

python skills/shinka-inspect/scripts/inspect_best_programs.py \
  --results-dir results/my_task_agent \
  --k 8 \
  --min-generation 10 \
  --max-code-chars 5000 \
  --out results/my_task_agent/inspect/top_programs.md

Output:

  • default file: results/my_task_agent/shinka_inspect_context.md
  • contains ranking + code snippets for top programs
  • designed to be loaded directly into coding-agent context

7) Batch Iteration Rules (Important)

When using shinka-run skill:

  • unless user explicitly requests fully autonomous execution, ask for config confirmation between batches
  • keep --results_dir the same across continuation batches so prior state can reload
  • change --results_dir only when intentionally forking a new run

8) Quick Validation Checklist

Before first run:

  • shinka_run --help works
  • task dir has evaluate.py + initial.<ext>
  • API keys are available in environment
  • skill files are installed under ~/.claude/skills and/or ~/.codex/skills

After each batch:

  • check run artifacts/logs under the chosen results_dir
  • review score and correctness trend
  • run shinka-inspect and review the generated context markdown
  • choose next batch config (budget, models, islands, attempts, generations)