Skip to content

Using with AI Tools ​

Scriptorium ships ready-made context files for all major AI coding assistants, so they can understand the framework, act as the Orchestrator, and run the full pipeline automatically.

Which File Each Tool Reads ​

ToolAuto-readsNotes
Claude CodeCLAUDE.mdAnthropic official CLI
OpenCodeAGENTS.mdOpen-source TUI assistant
AmpAGENTS.mdBy Sourcegraph
Cursor.cursor/rules/*.mdcIDE-embedded AI (alwaysApply: true)
Windsurf.windsurf/rules/*.mdCodeium/Windsurf IDE
OthersCLAUDE.mdMost tools read this automatically

Starting a Book Project ​

The workflow is identical regardless of which tool you use:

1. Open the project directory with your AI tool

bash
cd my-book
claude   # or opencode / cursor / windsurf

2. Say this one sentence

The source code for [project name] is in [directory path].
Please read QUICK_START.md, then ask me any questions you have.
If you have no questions, start your work.

The AI reads QUICK_START.md, collects basic information (title, audience, etc.), then runs the full 5-phase pipeline autonomously.

3. Resume after interruption

Please read checkpoint.md and continue where we left off.

Context File Reference ​

FileAudienceContents
QUICK_START.mdAI OrchestratorFull briefing: what to ask, how to run each phase, progress tracking
CLAUDE.mdClaude Code / generalFramework overview, architecture, file table, startup command
AGENTS.mdOpenCode / AmpSame as CLAUDE.md
.cursor/rules/scriptorium.mdcCursorSame, Cursor-specific format
.windsurf/rules/scriptorium.mdWindsurfSame, Windsurf-specific format

Important Notes ​

  • agents/ and framework/ are read-only framework core — never modify them
  • templates/ files contain placeholders — the AI fills them in at runtime
  • All output files are created automatically by the AI: research/, chapters/, reviews/, output/

Built with Meridian