# InkOS

> Open-source AI agent system for writing novels, short stories, scripts, interactive worlds and translations via Studio, TUI and CLI.

InkOS is an open-source story creation agent system published by Narcooo on GitHub. It covers long-form serial novels, standalone short stories, scripts, fan fiction, interactive open-world play and translation from one workspace, available through a web Studio, a terminal TUI and a CLI. The repository lists a v1.8.0 release and a 2.0.0 development branch built on a unified pi-agent harness.

## What It Is

InkOS is a writing-focused AI agent that manages ideas, settings, characters, memory, review, revision, covers and interactive state. Models propose and call capabilities, while InkOS handles confirmation, context assembly, state and atomic file commits. Users bring their own LLM service, such as Moonshot, Gemini, MiniMax, DeepSeek, OpenRouter or a custom OpenAI- or Anthropic-compatible endpoint.

## How the Writing Workflow Works

A long novel is created from a brief, which generates a story frame, volume map, character cards and book rules. Each chapter then runs through planning, context composition, writing, state settlement, review observations and atomic commit. Revision is a separate, explicit action. Chapter text and story state are saved together, so a failure does not leave state advanced without the text.

Long-term memory keeps authoritative structured JSON state validated by schema, human-readable Markdown projections, and a rebuildable SQLite FTS5/BM25 retrieval index. Editable control documents such as author intent and current focus guide each chapter.

## Formats and Outputs

- Short stories: full text, outline and review records, a sales package and cover prompt, plus a cover image if an image service is configured.
- Play: open-world and branching interactive worlds with world state, HUD, free actions and generated illustrations.
- Forecasting: 2-5 isolated future plot branches that save only a candidate plan without changing canon.
- Fan fiction (canon, AU, OOC, CP modes), style analysis and imitation, chapter import for continuation, and export to txt, md or EPUB.

## Skills and Agent Integration

InkOS uses standard SKILL.md files for professional methods, with 19 built-in skills. Project or user skills can override built-ins. It is also published as an OpenClaw skill, and `inkos interact --json` provides a structured entry point for external agents. A daemon mode can write chapters in the background and send notifications via Telegram, Feishu, WeCom or webhooks.

## Setup Path

Install with npm (Node.js 22.16 or later), run `inkos init`, then launch Studio and configure a service and API key. CLI, daemon and deployment environments can also override settings through environment variables.

## Features
- Long-form novel writing with planning, writing, review observations and atomic commit
- Short story generation with sales package and cover prompt
- Cover image generation
- InkOS Play open-world and branching interactive worlds
- Multi-branch plot forecasting
- Fan fiction modes (canon, AU, OOC, CP)
- Style analysis and imitation
- Import existing chapters to continue
- Long-term memory with SQLite FTS5/BM25 retrieval
- Standard SKILL.md skill support with built-in skills
- Multi-model routing per agent
- Studio web workbench, TUI and CLI
- Daemon mode with notifications
- Export to txt, md and EPUB

## Integrations
OpenClaw, ClawHub, Moonshot (Kimi), Google Gemini, MiniMax, DeepSeek, OpenRouter, kkaiapi, Ollama, LM Studio, OpenAI-compatible endpoints, Anthropic Messages, Telegram, Feishu, WeCom, Webhooks

## Platforms
WINDOWS, MACOS, LINUX, WEB, API, CLI

## Pricing
Open Source

## Version
v1.8.0

## Links
- Website: https://github.com/Narcooo/inkos
- Documentation: https://github.com/Narcooo/inkos#readme
- Repository: https://github.com/Narcooo/inkos
- EveryDev.ai: https://www.everydev.ai/tools/inkos