# narcooo/inkos

> inkos is an AI agent system for writing novels, short stories, scripts, interactive stories and translations. It runs each job as a pipeline of drafting, auditing, revising and settling story state, so characters, settings and plot records stay consistent across chapters. The project is written in TypeScript and published as npm packages.

Source: https://github.com/narcooo/inkos
Indexed: commit a6e05d4 on 2026-08-13 by Repowise. Facts come from the source and git history, not from the maintainer.

## Facts

- Type: App
- Language: TypeScript
- Stars: 11,219 at index time
- License: AGPL-3.0
- Code health: 6.0/10, Fair
- Last commit: 2026-08-01
- Contributors: 13

## Install

From the README: https://github.com/narcooo/inkos

Clone the inkos repository.
    git clone https://github.com/narcooo/inkos.git

Move into the inkos folder.
    cd inkos

Install InkOS globally from npm.
    npm i -g @actalk/inkos

Change into the project folder.
    cd my-novel

## How to use

Create a new project folder named my-novel.
    inkos init my-novel

## How it works

Input enters through the command line entry point at packages/cli/src/index.ts, the terminal interface in packages/cli/src/tui/app.ts, or the Studio web app, whose API server is packages/studio/src/api/server.ts. The core package in packages/core holds the writing logic, with packages/core/src/agent/index.ts exposing the agent and packages/core/src/agent/agent-tools.ts defining the tools the agent can call. Model access sits in packages/core/src/llm/providers/index.ts, which connects the agent to the configured model services. The Studio chat page in packages/studio/src/pages/ChatPage.tsx is one front end onto the same agent. Results are saved as files in the book project, and the agent's completion status comes from real tool results and those files.

- packages/cli/src/index.ts: entry point
- packages/cli/src/tui/app.ts: entry point
- packages/core/src/agent/index.ts: entry point
- packages/core/src/index.ts: entry point
- packages/core/src/llm/providers/index.ts: entry point
Modules: packages, root, .github, scripts, skills. 780 files, 151,576 lines, 4,505 symbols.

## Code health

- Score: 6.0/10 (Fair)
- Rank: #212 of 4,000+ indexed repos
- Hotspots: packages/studio/src/api/server.ts, packages/studio/src/api/server.test.ts, packages/core/src/agent/agent-tools.ts, packages/studio/src/pages/ChatPage.tsx, packages/core/src/agent/agent-system-prompt.ts
- Lowest file: packages/core/src/pipeline/runner.ts
- Dead code: 161 findings

## Maintenance

- Last commit 2026-08-01, first commit 2026-03-13, 1,467 commits
- 13 contributors, bus factor 1

## Security

- Security findings are shown to signed-in users at https://repowise.dev/repo/narcooo/inkos/security

## More

- Page: https://repowise.dev/repo/narcooo/inkos
- Ask this codebase: https://repowise.dev/repo/narcooo/inkos/chat
- Docs: https://repowise.dev/repo/narcooo/inkos/docs
- MCP (signs in with Repowise on first use):
    claude mcp add --transport http repowise https://api.repowise.dev/mcp/narcooo/inkos
