InkOS skill
A system for books and scripts: a CLI, Studio and an agent skill that write a novel by chapters, short fiction and scripts, and translate long texts
- 10,468 ★ on the repository
- Last commit
- AGPL-3.0
Broad access
Why this level
- API keys for model providers are stored on disk in `.inkos/secrets.json` and `~/.inkos/.env`
- `inkos up` writes chapters on a schedule with no person involved and sends notifications to Telegram, Feishu, WeCom and a webhook
- The system writes and rewrites project files, and the manuscript text goes to the model provider over the network
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add skills/inkosDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewBroad accessThe tool can change data, run commands or handle secrets.
- API keys for model providers are stored on disk in `.inkos/secrets.json` and `~/.inkos/.env`
- `inkos up` writes chapters on a schedule with no person involved and sends notifications to Telegram, Feishu, WeCom and a webhook
- The system writes and rewrites project files, and the manuscript text goes to the model provider over the network
This is third-party code. Review the repository files before installing.
What it does
InkOS is a system for working with fiction, installed from npm with `npm i -g @actalk/inkos`. It contains a browser Studio, the terminal `inkos tui`, CLI commands and the `skills/SKILL.md` skill for outside agents such as Claude Code and OpenClaw. For OpenClaw the skill can be installed with `clawhub install inkos`. Every route leads to one executor. It understands the request, picks a work profile and calls actions: create a book, plan and write chapters, review, revise, make a cover, export. There are several profiles: novel, short fiction, script, storyboard, interactive film, open world, fan fiction, continuation, style imitation and long-document translation. For an outside agent the author recommends starting with `inkos interact --json --message "..."`. Each work lives in project files: chapters, the author's intent in `story/author_intent.md`, the current focus, state snapshots and book rules. A review returns observations with evidence and does not score or rewrite the text; revision is a separate action. Nineteen professional skills are built in, and you can override them with your own `SKILL.md`.
Who it is for. For authors of web novels, short stories and scripts, and for people translating long texts who want to work through an agent without losing plot continuity and character state.
Good fit when
- You write a novel chapter by chapter and want the agent to remember canon, characters and open plot threads
- You need a finished short story with a plan, a review, a sales package and a cover from one `inkos short run` command
- You have a finished novel text and want to import it to continue from where it breaks off
- You want to write fan fiction from a source text in one of the modes: canon, alternate universe, out of character or pairing
- You need to translate a long document with terminology and the ability to resume an interrupted run
Not a fit when
- You need one small style edit: an ordinary request to the agent is enough, while the system creates a whole project with state files
- You have no API key from a model provider or a local model: without one the system writes nothing
- You want to embed the project in a closed product: the AGPL-3.0 license requires publishing the source of changes when used over a network
- You want prose scored by points: the review returns only qualitative observations and rates nothing
Example request
Continue the current book, but tighten the pacing, and show the review of chapter eightLimitations
You need Node.js 22.16 or newer and an API key from some model provider, or the address of a local model. The key is entered in Studio and kept in `.inkos/secrets.json`, or set in `~/.inkos/.env`. Covers require a separate image service setup.
The author writes the main description in Chinese, with English and Japanese versions. For English prose it ships metadata for ten genres, such as LitRPG, Romantasy and Cozy Fantasy, and for five Chinese ones: xuanhuan, xianxia, urban and horror, plus an other genre for everything else.
Version 2.0.0 merged the chat and the production pipelines into one executor. 1.x projects are migrated with `inkos work migrate --json` and `inkos work migrate --apply`, and the original folders are kept.
Outside skills give the agent only instructions and reference material, and InkOS does not run their scripts.
License AGPL-3.0.
How to disable. Remove the package with `npm uninstall -g @actalk/inkos`. Remove a skill installed through ClawHub from the OpenClaw skills directory, for example `~/.openclaw/skills/`. Book projects, the global `~/.inkos/.env` and the `.inkos/secrets.json` file with keys stay on disk, so delete them yourself if no longer needed. Stop background chapter writing by ending the process started with `inkos up`.
FAQ
How does InkOS differ from an ordinary request to write a chapter?
It keeps the state of the book: canon, characters, plot threads and a snapshot after each chapter. Prose, index and structured state are committed as one file set, so a failure never lets saved prose run ahead of state.
What does `inkos short run` do?
It runs the finished-short-story pipeline with `--direction`, `--chapters` and `--chars`. The result lands in `shorts/<name>/final/`: `full.md`, `sales-package.md`, `cover-prompt.md` and `cover.png` when a cover service is configured.
How does the fan fiction mode work?
`inkos fanfic init --from source.txt --mode canon` creates a book from a source text. There are four modes: canon, au, ooc and cp. The canon importer keeps the source's facts and the characters' information boundaries.
Can different roles use different models?
Yes. `inkos config set-model` assigns a model to each agent separately, for example one for the writer and another for the auditor. Agents without their own settings fall back to the global model.
What is daemon mode?
`inkos up` starts a background loop that writes chapters on a schedule. When human judgment is needed it stops with the result for review. Notifications go to Telegram, Feishu, WeCom and a webhook signed with HMAC-SHA256.
How do I continue a novel that is already written?
`inkos import chapters` imports the chapters, splitting by headings such as `Chapter N` or your own pattern, and rebuilds state, summaries, plot hooks and character relationships. After the import, `inkos write next` writes the next chapter.
Discussion
No questions or reviews yet.
Related
Skills24 skills for fiction in Markdown, from premise to print, and a story command that catches plot contradictions before readers do
A plugin for novels and serial fiction: a muse agent leads from idea to draft, while writer, critic, editor and canon-check agents each handle one job
A set of 13 skills for writing web fiction inside a coding agent: rank scanning, hit deconstruction, outline and prose, AI-flavor cleanup, cover art
A novel-writing skill with nine agents: setting, volume and chapter plans, prose, a machine-style check and an archive with character memory
Addy Osmani skill for clearer writing: an interview and draft from your own words, a rewrite of existing text, a review that leaves the file alone
A de-AI writing skill: it repairs the narrative architecture of fiction and edits professional documents by their venue rules
Comparison with similar tools
Entries that share the main search query, and how they differ.
| Entry | Official | Repository stars | Main difference |
|---|---|---|---|
| InkOS (this entry) | no | 10,468 | |
| chinese-novelist | no | 4,124 | a single skill for a Chinese novel written by chapters, with an author interview and preference memory |
| Shanyin Screenwriting Master | no | 1,377 | a screenwriter skill for formats from a short clip to a series, with no chapter pipeline or stored book state |
README in short
The description, in Chinese, English and Japanese, opens with an overview of version 2.0.0 and the list of creation modes. Installation, OpenClaw integration, the skill format, three ways to configure a model, and examples for a first book, a short story, a cover and an open world follow. Separate sections explain memory, control documents, length rules, a command reference and a roadmap. The repository holds the cli and core packages with 19 built-in skills and their reference files, plus a changelog and contributor guidance.
README badge
Original SKILL.md
--- name: inkos description: Use InkOS as a Pi-agent creative harness for novels, short fiction, scripts, storyboards, interactive films, open worlds, derivative works, and long-document translation. --- # InkOS Creative Harness InkOS is a text-creation harness. The main Pi agent understands the request, activates professional Skills, invokes typed capability actions, and reports only persisted results. ## Core contract - Discussion stays discussion. Creation and mutation happen only through capability actions. - A successful action is proven by its `ActionResult` and artifact revision, never by assistant prose. - User intent, current Work constraints, established facts, and explicit prohibitions outrank model defaults. - Skills provide professional methods but never grant write permission. - Review returns evidence-backed observations. It does not score prose, reject a chapter, or authorize an automatic rewrite. - Revision is an explicit action. Preserve source revisions and report the new artifact revision. - Context is assembled per task: LLM semantic selection chooses relevant source sections after deterministic candidate discovery. Protected intent and selected current facts are never compressed; lower-priority context is semantically compiled only on budget overflow. ## Creation profiles - `longform-novel`: foundation, chapter planning, writing, review, revision, state projection, forecast, cover. - `short-fiction`: complete short story, plan, review notes, sales package, cover. - `script`: screenplay, vertical short drama, audio drama, interactive script. - `storyboard`: editable storyboard, typed image-prompt assets, image generation. - `interactive-film`: story tree, flags, script, storyboard, image assets, playable graph, export. - `play-world`: open-world or guided interaction with persistent entities, relationships, time, evidence, inventory, scenes, and images. - `fanfic`, `spinoff`, `imitation`, `continuation`: derivative creation with explicit lineage and source canon. - `translation`: multilingual long-document translation with terminology and resumable artifacts. ## Natural-language use Use normal conversation to discuss or request work. The agent chooses the relevant profile and Skill. A creation proposal may require confirmation; recoverable edits inside the current Work can run directly. Force a Skill when needed: ```text @inkos-story-review review chapter 8 against the current reader promise @inkos-imitation-writing keep the reference cadence but create a new story ``` Inspect available Skills and Works through the agent tools rather than guessing storage paths. ## Explicit CLI actions