From e634affa7a9ff952cc62e4d7847c0522b23897cd Mon Sep 17 00:00:00 2001 From: Ma Date: Wed, 15 Apr 2026 12:54:03 +0800 Subject: [PATCH] docs: keep mainline readmes and skill metadata --- README.en.md | 11 +++++++---- README.ja.md | 9 ++++++--- README.md | 11 +++++++---- skills/SKILL.md | 22 +++++++++++++++++----- 4 files changed, 37 insertions(+), 16 deletions(-) diff --git a/README.en.md b/README.en.md index 93e7adb..4dab144 100644 --- a/README.en.md +++ b/README.en.md @@ -3,13 +3,14 @@ InkOS

-

Autonomous Novel Writing CLI AI Agent

+

Autonomous Novel Writing AI Agent

npm version License: AGPL-3.0 - Node.js - TypeScript + GitHub stars + npm downloads + ClawHub Skill

@@ -18,7 +19,9 @@ --- -Open-source CLI AI Agent that autonomously writes, audits, and revises novels — with human review gates that keep you in control. Supports LitRPG, Progression Fantasy, Isekai, Romantasy, Sci-Fi, and more. Continuation, spinoff, fanfic, and style imitation workflows built in. +Open-source AI Agent that autonomously writes, audits, and revises novels — with human review gates that keep you in control. Supports LitRPG, Progression Fantasy, Isekai, Romantasy, Sci-Fi, and more. Continuation, spinoff, fanfic, and style imitation workflows built in. + +**InkOS TUI is here!** — run `inkos` to launch a full-screen interactive dashboard. Conversational creation, natural-language book operations, slash command autocomplete, themed animations — TUI, Studio, and OpenClaw share the same interaction kernel. **InkOS Studio is here!** — run `inkos studio` to launch a local web workbench. Book management, chapter review & editing, real-time writing progress, market radar, analytics, AI detection, style analysis, genre management, daemon control, truth file editing — everything the CLI does, now visual. diff --git a/README.ja.md b/README.ja.md index a73c5b7..f132b95 100644 --- a/README.ja.md +++ b/README.ja.md @@ -3,13 +3,14 @@ InkOS

-

自律型小説執筆 CLI AIエージェント

+

自律型小説執筆 AIエージェント

npm version License: AGPL-3.0 - Node.js - TypeScript + GitHub stars + npm downloads + ClawHub Skill

@@ -20,6 +21,8 @@ 小説の執筆・監査・修正を自律的に行うオープンソースCLIエージェント。人間によるレビューゲートにより、常にコントロールを維持できます。LitRPG、プログレッションファンタジー、異世界転生、ロマンタジー、SF など多数のジャンルに対応。続編・スピンオフ・二次創作・文体模倣ワークフローを内蔵。 +**InkOS TUI 正式リリース！** — `inkos` を実行してフルスクリーンのインタラクティブダッシュボードを起動。会話型創作、自然言語での書籍操作、スラッシュコマンド自動補完、テーマアニメーション——TUI、Studio、OpenClaw が同一のインタラクションカーネルを共有。 + **InkOS Studio 正式リリース！** — `inkos studio` でローカルWebワークベンチを起動。書籍管理、章のレビュー＆編集、リアルタイム執筆進捗、市場レーダー、アナリティクス、AI検出、スタイル分析、ジャンル管理、デーモン制御、真実ファイル編集 — CLIの全機能をビジュアルで利用可能。 **英語ネイティブ小説執筆に対応！** — 10種類の英語ジャンルプロファイルを内蔵し、専用のペーシングルール、疲労語リスト、監査ディメンションを搭載。`--lang en` を設定するだけですぐに始められます。 diff --git a/README.md b/README.md index 4a129b1..376adb0 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,14 @@ InkOS

-

Autonomous Novel Writing CLI AI Agent
自动化小说写作 CLI AI Agent

+

Autonomous Novel Writing AI Agent
自动化小说写作 AI Agent

npm version License: AGPL-3.0 - Node.js - TypeScript + GitHub stars + npm downloads + ClawHub Skill

@@ -20,6 +21,8 @@ AI Agent 自主写小说——写、审、改，全程接管。覆盖玄幻、仙侠、都市、科幻等多种风格，支持续写、番外、同人、仿写等创作形式。人工审核门控确保你始终掌控全局。已发布为 [OpenClaw](https://clawhub.ai/narcooo/inkos) skill。 +**InkOS TUI 正式发布！** — 直接运行 `inkos` 进入全屏交互仪表盘。对话式创作、自然语言操作书籍、slash 命令补全、主题动效——TUI、Studio、OpenClaw 共享同一套交互内核。 + **InkOS Studio 正式发布！** — `inkos studio` 启动本地 Web 工作台。书籍管理、章节审阅编辑、实时写作进度、市场雷达、数据分析、AI 检测、文风分析、题材管理、守护进程控制、真相文件编辑——CLI 能做的，Studio 全部可视化。 **Native English novel writing now supported！** Set `--lang en` to write in English. See [English README](README.en.md) for details. @@ -30,7 +33,7 @@ AI Agent 自主写小说——写、审、改，全程接管。覆盖玄幻、 > 欢迎加群反馈问题、提出需求，也欢迎关注项目动态 — 我们的目标是做最强的基于小说的内容生态创作 AI Agent。

- 微信交流群 + 微信交流群

## 快速开始 diff --git a/skills/SKILL.md b/skills/SKILL.md index 40878b3..16e97c4 100644 --- a/skills/SKILL.md +++ b/skills/SKILL.md @@ -1,8 +1,8 @@ --- name: inkos description: Autonomous novel writing CLI agent with web workbench (InkOS Studio) - use for creative fiction writing, novel generation, style imitation, chapter continuation/import, EPUB export, AIGC detection, and fan fiction. Native English support with 10 built-in English genre profiles (LitRPG, Progression Fantasy, Isekai, Cultivation, System Apocalypse, Dungeon Core, Romantasy, Sci-Fi, Tower Climber, Cozy Fantasy). Also supports Chinese web novel genres (xuanhuan, xianxia, urban, horror, other). Multi-agent pipeline, two-phase writer (creative + settlement), 33-dimension auditing, token usage analytics, creative brief input, structured logging (JSON Lines), multi-model routing, custom OpenAI-compatible provider support, and InkOS Studio web UI for visual book management, chapter review, real-time writing progress, market radar, and analytics. -version: 2.3.0 -metadata: { "openclaw": { "emoji": "📖", "requires": { "bins": ["inkos", "node"], "env": [] }, "primaryEnv": "", "homepage": "https://github.com/Narcooo/inkos", "install": [{ "id": "npm", "kind": "node", "package": "@actalk/inkos", "label": "Install InkOS (npm)" }] } } +version: 2.3.2 +metadata: { "openclaw": { "emoji": "📖", "requires": { "bins": ["inkos", "node"], "env": ["OPENAI_API_KEY"] }, "primaryEnv": "OPENAI_API_KEY", "homepage": "https://github.com/Narcooo/inkos", "install": [{ "id": "npm", "kind": "node", "package": "@actalk/inkos", "label": "Install InkOS (npm)" }] } } --- # InkOS - Autonomous Novel Writing Agent @@ -37,9 +37,11 @@ Truth files are persisted as schema-validated JSON (`story/state/*.json`) with m inkos init my-writing-project # Configure your LLM provider (OpenAI, Anthropic, or any OpenAI-compatible API) -inkos config set-global --provider openai --base-url https://api.openai.com/v1 --api-key sk-xxx --model gpt-4o -# For compatible/proxy endpoints, use --provider custom: -# inkos config set-global --provider custom --base-url https://your-proxy.com/v1 --api-key sk-xxx --model gpt-4o +# Prefer --api-key-env so the key never appears in shell history: +export OPENAI_API_KEY=sk-xxx +inkos config set-global --provider openai --base-url https://api.openai.com/v1 --api-key-env OPENAI_API_KEY --model gpt-4o +# For compatible/proxy endpoints, use --provider custom and point ONLY to trusted endpoints: +# inkos config set-global --provider custom --base-url https://your-trusted-proxy.com/v1 --api-key-env OPENAI_API_KEY --model gpt-4o ``` ### Multi-Model Routing (Optional) @@ -562,6 +564,16 @@ inkos down 8. **Check analytics**: Use `inkos analytics` to track quality trends over time 9. **Export frequently**: Keep backups with `inkos export` +## Security & Trust + +- **License**: the ClawHub skill descriptor is MIT-0 per platform policy, but the underlying `@actalk/inkos`, `@actalk/inkos-core`, and `@actalk/inkos-studio` npm packages are **AGPL-3.0-only**. Running InkOS and distributing modified versions are governed by AGPL. Full source on GitHub for auditability. +- **No install hooks**: npm package has no `preinstall`/`postinstall`/`install` scripts. Install is inert. +- **Local-only file I/O**: all read/write stays inside the project directory (`books/*`, `inkos.json`, `inkos.log`). No writes outside the working directory. +- **No telemetry**: InkOS does not phone home, collect usage stats, or ship any data to InkOS-controlled servers. The only outbound traffic is to the LLM provider endpoint you explicitly configure. +- **Credential handling**: always prefer `--api-key-env ` over `--api-key ` so keys never hit shell history. Keys are stored in `inkos.json` under your project directory — treat it like a secret and add it to `.gitignore` if you commit the project. +- **Custom provider base-URL**: `--provider custom` forwards your API key to whatever URL you specify. Only point it at endpoints you trust (your own proxy or an audited reverse-proxy). Never paste an untrusted `--base-url`. +- **No elevated privileges**: InkOS requires no sudo, no global state mutation, no network listening port (Studio binds `localhost:4567` only). + ## Support & Resources - **Homepage**: https://github.com/Narcooo/inkos