|
|
@@ -40,7 +40,7 @@ clawhub install inkos # Install from ClawHub
|
|
|
|
|
|
If you installed via npm or cloned the repo, `skills/SKILL.md` is already included — 🦞 can read it directly without a separate ClawHub install.
|
|
|
|
|
|
-Once installed, Claw can invoke all InkOS atomic commands (`draft`/`audit`/`revise`/`write next`) via `exec`, with `--json` output for structured decision-making. You can also browse it on [ClawHub](https://clawhub.ai) by searching `inkos`.
|
|
|
+Once installed, Claw can invoke InkOS atomic commands and control-surface operations (`plan chapter`/`compose chapter`/`draft`/`audit`/`revise`/`write next`) via `exec`, with `--json` output for structured decision-making. The recommended flow is: update `author_intent.md` or `current_focus.md`, run `plan` / `compose`, then decide whether to call `draft` or the full `write next` pipeline. You can also browse it on [ClawHub](https://clawhub.ai) by searching `inkos`.
|
|
|
|
|
|
### Configure
|
|
|
|
|
|
@@ -158,7 +158,23 @@ De-AI-ification rules are baked into the Writer agent's prompts: fatigue word li
|
|
|
|
|
|
### Creative Brief
|
|
|
|
|
|
-`inkos book create --brief my-ideas.md` — pass your brainstorming notes, worldbuilding doc, or character sheets. The Architect agent builds from your brief (generating story_bible.md and book_rules.md) instead of inventing from scratch.
|
|
|
+`inkos book create --brief my-ideas.md` — pass your brainstorming notes, worldbuilding doc, or character sheets. The Architect agent builds from your brief (generating `story_bible.md` and `book_rules.md`) instead of inventing from scratch, and persists the brief into `story/author_intent.md` so the book's long-horizon intent does not disappear after initialization.
|
|
|
+
|
|
|
+### Input Governance Control Surface
|
|
|
+
|
|
|
+Every book now has two long-lived Markdown control docs:
|
|
|
+
|
|
|
+- `story/author_intent.md`: what this book should become over the long horizon
|
|
|
+- `story/current_focus.md`: what the next 1-3 chapters should pull attention back toward
|
|
|
+
|
|
|
+Before writing, you can run:
|
|
|
+
|
|
|
+```bash
|
|
|
+inkos plan chapter my-book --context "Pull attention back to the mentor conflict first"
|
|
|
+inkos compose chapter my-book
|
|
|
+```
|
|
|
+
|
|
|
+This generates `story/runtime/chapter-XXXX.intent.md`, `context.json`, `rule-stack.yaml`, and `trace.json`. `intent.md` is the human-readable contract; the others are execution/debug artifacts. `plan` / `compose` only compile local documents and state, so they can run before you finish API key setup.
|
|
|
|
|
|
### Continuation Writing
|
|
|
|
|
|
@@ -224,11 +240,24 @@ The Continuity Auditor checks every draft against these files. If a character "r
|
|
|
<img src="assets/screenshot-state.png" width="800" alt="Truth files snapshot">
|
|
|
</p>
|
|
|
|
|
|
+### Control Surface and Runtime Artifacts
|
|
|
+
|
|
|
+Alongside the 7 truth files, InkOS splits guardrails from customization into reviewable control docs:
|
|
|
+
|
|
|
+- `story/author_intent.md`: long-horizon author intent
|
|
|
+- `story/current_focus.md`: near-term steering
|
|
|
+- `story/runtime/chapter-XXXX.intent.md`: chapter goal, keep/avoid list, conflict resolution
|
|
|
+- `story/runtime/chapter-XXXX.context.json`: the actual context selected for this chapter
|
|
|
+- `story/runtime/chapter-XXXX.rule-stack.yaml`: priority layers and override relationships
|
|
|
+- `story/runtime/chapter-XXXX.trace.json`: compilation trace for this chapter
|
|
|
+
|
|
|
+That means briefs, outline nodes, book rules, and current requests are no longer mashed into one prompt blob; InkOS compiles them first, then writes.
|
|
|
+
|
|
|
### Writing Rule System
|
|
|
|
|
|
The Writer agent has ~25 universal writing rules (character craft, narrative technique, logical consistency, language constraints, de-AI-ification), applicable to all genres.
|
|
|
|
|
|
-On top of that, each genre has dedicated rules (prohibitions, language constraints, pacing, audit dimensions), and each book has its own `book_rules.md` (protagonist personality, numerical caps, custom prohibitions) and `story_bible.md` (worldbuilding), auto-generated by the Architect agent.
|
|
|
+On top of that, each genre has dedicated rules (prohibitions, language constraints, pacing, audit dimensions), and each book has its own `book_rules.md` (protagonist personality, numerical caps, custom prohibitions), `story_bible.md` (worldbuilding), `author_intent.md` (long-horizon direction), and `current_focus.md` (near-term steering). `volume_outline.md` still acts as the default plan, but in v2 input governance it no longer automatically overrides the current chapter intent.
|
|
|
|
|
|
## Usage Modes
|
|
|
|
|
|
@@ -241,15 +270,27 @@ inkos write next my-book # Draft → audit → auto-revise, all in
|
|
|
inkos write next my-book --count 5 # Write 5 chapters in sequence
|
|
|
```
|
|
|
|
|
|
+If you want `write next` to always go through the `plan -> compose -> write` governance chain, set this in `inkos.json`:
|
|
|
+
|
|
|
+```json
|
|
|
+{
|
|
|
+ "inputGovernanceMode": "v2"
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+The default remains `legacy` so existing projects do not silently change behavior.
|
|
|
+
|
|
|
### 2. Atomic Commands (Composable, External Agent Friendly)
|
|
|
|
|
|
```bash
|
|
|
+inkos plan chapter my-book --context "Focus on the mentor conflict first" --json
|
|
|
+inkos compose chapter my-book --json
|
|
|
inkos draft my-book --context "Focus on the dungeon boss encounter and party dynamics" --json
|
|
|
inkos audit my-book 31 --json
|
|
|
inkos revise my-book 31 --json
|
|
|
```
|
|
|
|
|
|
-Each command performs a single operation independently. `--json` outputs structured data. Can be called by external AI agents via `exec`, or used in scripts.
|
|
|
+Each command performs a single operation independently. `--json` outputs structured data. `plan` / `compose` govern inputs; `draft` / `audit` / `revise` handle prose and quality checks. They can be called by external AI agents via `exec`, or used in scripts.
|
|
|
|
|
|
### 3. Natural Language Agent Mode
|
|
|
|
|
|
@@ -259,7 +300,7 @@ inkos agent "Write the next chapter, focus on the boss fight and loot distributi
|
|
|
inkos agent "Create a progression fantasy about a mage who can only use one spell"
|
|
|
```
|
|
|
|
|
|
-13 built-in tools (write_draft, audit_chapter, revise_chapter, scan_market, create_book, get_book_status, read_truth_files, list_books, write_full_pipeline, web_fetch, import_style, import_canon, import_chapters), with the LLM deciding call order via tool-use.
|
|
|
+18 built-in tools (write_draft, plan_chapter, compose_chapter, audit_chapter, revise_chapter, scan_market, create_book, update_author_intent, update_current_focus, get_book_status, read_truth_files, list_books, write_full_pipeline, web_fetch, import_style, import_canon, import_chapters, write_truth_file), with the LLM deciding call order via tool-use. The recommended agent flow is: adjust the control surface first, then `plan` / `compose`, then choose draft-only or full-pipeline writing.
|
|
|
|
|
|
## CLI Reference
|
|
|
|
|
|
@@ -271,6 +312,8 @@ inkos agent "Create a progression fantasy about a mage who can only use one spel
|
|
|
| `inkos book list` | List all books |
|
|
|
| `inkos book delete <id>` | Delete a book and all its data (`--force` to skip confirmation) |
|
|
|
| `inkos genre list/show/copy/create` | View, copy, or create genres |
|
|
|
+| `inkos plan chapter [id]` | Generate the next chapter's `intent.md` (`--context` / `--context-file` for current steering) |
|
|
|
+| `inkos compose chapter [id]` | Generate the next chapter's `context.json`, `rule-stack.yaml`, and `trace.json` |
|
|
|
| `inkos write next [id]` | Full pipeline: write next chapter (`--words` to override, `--count` for batch, `-q` quiet mode) |
|
|
|
| `inkos write rewrite [id] <n>` | Rewrite chapter N (restores state snapshot, `--force` to skip confirmation) |
|
|
|
| `inkos draft [id]` | Write draft only (`--words` to override word count, `-q` quiet mode) |
|
|
|
@@ -293,7 +336,7 @@ inkos agent "Create a progression fantasy about a mage who can only use one spel
|
|
|
| `inkos analytics [id]` / `inkos stats [id]` | Book analytics (audit pass rate, top issues, chapter ranking, token usage) |
|
|
|
| `inkos up / down` | Start/stop daemon (`-q` quiet mode, auto-writes `inkos.log`) |
|
|
|
|
|
|
-`[id]` is auto-detected when the project has only one book. All commands support `--json` for structured output. `book create` supports `--brief <file>` to pass a creative brief — the Architect builds from your ideas instead of generating from scratch.
|
|
|
+`[id]` is auto-detected when the project has only one book. All commands support `--json` for structured output. `draft` / `write next` / `plan chapter` / `compose chapter` accept `--context` for steering. `book create` supports `--brief <file>` to pass a creative brief — the Architect builds from your ideas instead of generating from scratch. `plan chapter` / `compose chapter` do not require a live LLM, so you can inspect governed inputs before finishing API setup.
|
|
|
|
|
|
## Roadmap
|
|
|
|