Skip to content

InkOS

by Junxian MaAgentWrite better

Helps you plan, write and revise novels, short stories and scripts with an AI agent

View on GitHub

About InkOS

InkOS is an open source AI writing system for novels, short stories, scripts and interactive stories. You give it a brief or notes; it plans, drafts and revises chapters while tracking the story, and can export an EPUB.

For Novelists and web-novel authorsScriptwritersInteractive fiction makers

Made by Junxian Ma

An open-source project by developer Junxian Ma, published on GitHub under the account Narcooo and released under the AGPL-3.0 licence.

Stars
★ 11k
License
AGPL-3.0
Cost
Usage-based
Platforms
Mac · Win · Linux
Level
Intermediate

Overview

InkOS is an open-source writing agent for long novels, short stories, scripts and interactive stories. You give it a brief or your notes; it sets up the world, characters and chapter plans, writes chapters, keeps a record of characters, plot threads and story state, and exports the book as an EPUB. It runs on your computer, with a browser workspace called Studio and a terminal mode, using a model service you connect. It suits fiction writers and web-novel authors working on long projects.

It keeps a running record of characters, plot hooks and story state between chapters, so a long book stays consistent instead of drifting.

Try these first

Start with the first one: it is a small task you can check easily.

  1. Here is my story idea: [paste idea]. Write a one-paragraph brief and a three-chapter outline. Don't write any chapters yet.First try · outline only

  2. Write the next chapter of [book name] and keep the pacing tight.uses model credits

  3. Check chapter [number] against the outline and list any continuity problems.

  4. Export [book name] as an EPUB file.writes files

Example prompts written by Agent Flows Hub.

Features

From the creator's documentation.

FeatureWhat it doesRuns
Book planningSets up the world, characters, volume map and chapter plans from your briefModel service
Chapter writingWrites the next chapter, or several in a row, and saves them in your projectModel service
Story memoryTracks characters, relationships, plot hooks and story state between chaptersYour computer
Review and revisionCompares a chapter with your intent and the story so far, and revises when you askModel service
Other formatsShort stories, scripts, storyboards and branching interactive storiesModel service
EPUB exportExports a book to read on a phone or e-readerYour computer

Good to know

You are writing a long novel or serial and want help keeping characters, plot threads and chapter plans straight. InkOS plans and writes chapters from a brief, updates its record of the story after each one, and lets you check and revise before it continues.

Limits

  • It needs Node.js and an API key for a model service; the writing and the cost depend on the model you connect.
  • The README on the main branch describes a 2.0 development version, while the npm package is 1.8.0. Follow the steps for the version you install.

Notes by (original project name: InkOS), written from the creator's documentation, not from running it ourselves. InkOS README (English)

Stuck setting it up?

Tell us what happened. We take a look first; if it needs paid work, you get an estimate before anything starts.

Get help

Other agents

  • Kilo Code Hands your coding tasks to an agent in VS Code, JetBrains or the terminal
  • Kimi Hands a task to Moonshot AI's agent, which returns slides, documents, sheets or a website
  • Lindy Drafts email replies, books meetings and takes meeting notes from your connected accounts
  • LiveAgent Gives you a desktop AI agent that edits files, runs commands and handles scheduled jobs
  • LLM for Zotero Lets you chat with papers in Zotero, get cited answers and save them as notes
  • LobsterAI Works through office tasks on your desktop, from spreadsheet analysis to slides and docs

See all 61 agents · Install your first AI agent

GitHub