name: inkos description: Autonomous novel writing CLI agent - use for creative fiction writing, novel generation, style imitation, chapter continuation, and AIGC detection. Supports Chinese web novel genres (xuanhuan, xianxia, urban, horror, other) with multi-agent pipeline and advanced auditing. version: 1.0.0
InkOS is a CLI tool for autonomous fiction writing powered by LLM agents. It orchestrates a 5-agent pipeline (Radar → Architect → Writer → Auditor → Reviser) to generate, audit, and revise novel content with style consistency and quality control.
# Initialize a project directory (creates config structure)
inkos init my-writing-project
# Configure your LLM provider (OpenAI, Anthropic, or compatible)
inkos config set-global --provider openai --base-url https://api.openai.com/v1 --api-key sk-xxx --model gpt-4o
# Check installation and configuration
inkos doctor
# View current config
inkos status
Initialize and create book:
inkos book create --title "My Novel Title" --genre xuanhuan --chapter-words 3000
xuanhuan (cultivation), xianxia (immortal), urban (city), horror, otherbook-id for all subsequent operationsGenerate initial chapters (e.g., 5 chapters):
inkos write next book-id --count 5 --words 3000 --context "young protagonist discovering powers"
write next command runs the full pipeline: draft → audit → revise--context provides guidance to the Architect and Writer agentsReview and approve chapters:
inkos review list book-id
inkos review approve-all book-id
Export the book:
inkos export book-id
List your books:
inkos book list
Continue from last chapter:
inkos write next book-id --count 3 --words 2500 --context "protagonist faces critical choice"
book-id for auto-detectionReview and approve:
inkos review approve-all
Analyze reference text:
inkos style analyze reference_text.txt
Import style to your book:
inkos style import reference_text.txt book-id --name "Author Name"
Import parent canon:
inkos import canon spinoff-book-id --from parent-book-id
Continue spinoff:
inkos write next spinoff-book-id --count 3 --context "alternate timeline after Chapter 20"
If you need separate control over each pipeline stage:
Generate draft only:
inkos draft book-id --words 3000 --context "protagonist escapes" --json
Audit the chapter (32-dimension quality check):
inkos audit book-id chapter-1 --json
Revise with specific mode:
inkos revise book-id chapter-1 --mode polish --json
polish (minor), spot-fix (targeted), rewrite (major), rework (structure), anti-detect (reduce AI traces)inkos radar scan
# Detect AIGC in a specific chapter
inkos detect book-id
# Deep scan all chapters
inkos detect book-id --all
For flexible, conversational requests:
inkos agent "写一部都市题材的小说,主角是一个年轻律师,第一章三千字"
If your project contains only one book, most commands accept book-id as optional. You can omit it for brevity:
# Explicit
inkos write next book-123 --count 1
# Auto-detected (if only one book exists)
inkos write next --count 1
All content-generating commands support --json for structured output. Essential for programmatic use:
inkos draft book-id --words 3000 --context "guidance" --json
InkOS maintains 7 files per book for coherence:
All agents reference these to maintain long-term consistency.
The --context parameter provides directional hints to the Writer and Architect:
inkos write next book-id --count 2 --context "protagonist discovers betrayal, must decide whether to trust mentor"
inkos genre list
inkos genre show xuanhuan
inkos genre create --name "my-genre" --rules "rule1,rule2,rule3"
inkos genre copy xuanhuan --name "dark-xuanhuan" --rules "darker tone, more violence"
| Command | Purpose | Notes |
|---|---|---|
inkos init [name] |
Initialize project | One-time setup |
inkos book create |
Create new book | Returns book-id |
inkos book list |
List all books | Shows IDs, statuses |
inkos write next |
Full pipeline (draft→audit→revise) | Primary workflow command |
inkos draft |
Generate draft only | No auditing/revision |
inkos audit |
32-dimension quality check | Standalone evaluation |
inkos revise |
Revise chapter | Modes: polish/spot-fix/rewrite/rework/anti-detect |
inkos agent |
Natural language interface | Flexible requests |
inkos style analyze |
Analyze reference text | Extracts style profile |
inkos style import |
Apply style to book | Makes style permanent |
inkos import canon |
Link spinoff to parent | For prequels/sequels |
inkos detect |
AIGC detection | Flags AI-generated passages |
inkos export |
Export finished book | Outputs formatted manuscript |
inkos radar scan |
Platform trend analysis | Informs new book ideas |
inkos config set-global |
Configure LLM provider | Openai/Anthropic/compatible |
inkos doctor |
Diagnose issues | Check installation |
inkos up/down |
Daemon mode | Background processing |
inkos review list/approve-all |
Manage chapter approvals | Quality gate |
"book-id not found"
inkos book list"Provider not configured"
inkos config set-global with valid credentialsinkos doctor"Context invalid"
--context is a string (wrap in quotes if multi-word)"Audit failed"
inkos revise with --mode rewriteFor long-running operations:
# Start background daemon
inkos up
# Stop daemon
inkos down
# Daemon auto-processes queued chapters
--context, the more coherent the narrativeinkos style import before generationinkos review to catch issues earlyinkos audit metrics to understand quality bottlenecksinkos exportinkos init.inkos/ directory per bookinkos doctor for troubleshooting