📚 story-cli

Null-Deployment, Git-natives Markdown-Content-Management-CLI. Verwalte Geschichten/Papiere/Notizen/Tutorials mit einfachen Verzeichnis-Konventionen, generiere automatisch README, exportiere EPUB, zweisprachig Chinesisch/Englisch.

✨ Funktionen

• Einfache Verzeichnis-Konvention — Inhalt ist ein Ordner: NN-名称/ enthält config.json + text.md

• Automatische README-Generierung — Jeder Eintrag und das Root-Index werden automatisch generiert (templategesteuert, anpassbar)

• Seriengruppierung und Sortierung — series / seriesOrder steuern die Anzeigereihenfolge, beliebiges Einfügen ohne Neuordnung

• Laufzeitvalidierung — Konfiguration wird vor dem Build geprüft (Pflichtfelder, Enums, Formate)

• Compliance-Prüfung — story validate prüft nach Story-Repo-Spezifikation (Verzeichnisbenennung / UTF-8 / doppelte Nummern / Schema)

• Verknüpfte Geschichten — story link verwaltet schwache Verknüpfungen; story build schlägt automatisch Kandidaten für Serienverknüpfungen vor

• Zweisprachige Unterstützung — Chinesisch/Englisch-Inhalte + automatisch generierte lokalisierte READMEs

• Kapitel + Wortanzahl — Automatische Extraktion von Kapitelüberschriften und sprachbewusste Wortstatistik

• Mehrformat-Export — EPUB (Cover-Rendering/Layout-Stile/Serienmetadaten) / HTML / TXT / JSON / Markdown / embeddings, unterstützt --stdout-Pipes

• Allgemeine Content-Plattform — Wissensdatenbank-Modus (Papiere/Interviews/Notizen), Technische-Dokumentation-Modus (Tutorials/API)

• MCP-Server — KI-Clients (Claude / Cursor) können direkt auf die Inhaltsbibliothek lesen und schreiben

• GitHub Action — Null-Konfigurations-CI-Einstieg (yuelinghuashu/story-cli@v1), ein Klick für „Push → Build → Veröffentlichen"

• Watch-Modus — Automatischer Neubau bei Dateiänderungen

Related MCP server: obsidian-kb

🚀 Schnellstart

# 安装（需要 Node.js >= 22）
npm install -g @yuelinghuashu/story-cli

# 创建示例仓库并查看效果
story demo

# 初始化仓库
story init

# 创建内容并编写
story new "我的新故事"

# 构建所有 README
story build

# 导出 EPUB / 统计
story epub --all
story stats

make init                 # 初始化
make new TITLE="我的故事"  # 新建并自动构建
make commit               # 构建 + 提交
make push                 # 构建 + 提交 + 推送
make stats                # 查看创作统计
make analyze              # 写作质量分析（重复短语 / 字数过期 / 章节趋势，需 jq）

Windows-Benutzer können auch den von story init generierten story.ps1 (PowerShell-Workflow) verwenden: .\story.ps1 init / .\story.ps1 new -Title '我的故事' / .\story.ps1 build.

🌱 Mehr als nur Geschichten

Allgemeine Inhaltsverwaltung — Jedes Text-Asset, das „normalisiert" werden kann, kann mit demselben Workflow verwaltet werden:

story init --template=knowledge
story init --template=tech

🤖 Lass KI deine Inhaltsbibliothek verwalten

story-cli enthält einen integrierten MCP-Server – KI-Clients (Claude Desktop / Cursor / VSCode Copilot Chat) können direkt auf deine Inhaltsbibliothek lesen und schreiben. Die KI kann den vollständigen Kreislauf „Erstellen → Schreiben → Bauen → Statistiken" eigenständig durchführen, ohne manuelle Befehle im Terminal.

💡 Token-Effizienz: Die MCP-Tools sind von Anfang an darauf ausgelegt, KI-Aufrufkosten zu sparen. scan_stories liefert standardmäßig kompakte Ausgaben (Verzeichnisdurchsicht spart ~80-95%), read_chapter unterstützt bedarfsgesteuertes Abschneiden (Fortsetzungsszenarien sparen ~95%+), stats liefert alle Daten mit einem Aufruf (~99%) – jedes Detail reduziert den Token-Verbrauch für deinen KI-Workflow.

# 启动 MCP Server（需在故事仓库根目录；--root 可从任意目录指定仓库）
story mcp-server

💡 Detaillierte Konfiguration und Beispiele findest du in docs/mcp.md. Der MCP-Server liest und schreibt alle Dateien im aktuellen Arbeitsverzeichnis. Bitte nur in vertrauenswürdigen Repositories ausführen.

🎯 Vorbereitung von Feintuning-Daten (SFT / Embedding)

Die strukturierte Ausgabe der Geschichtsbibliothek eignet sich natürlich als Datenquelle für das Training großer Modelle – config.json enthält Klassifikations-Tags, export json schneidet präzise nach Kapiteln, export embeddings gibt reine Textblöcke aus. In Kombination mit --stdout + Unix-Toolchain, eine einzige Pipeline-Zeile reicht, um in ein Standard-Feintuning-Format zu konvertieren:

# 导出为指令微调 JSONL（summary → instruction，正文 → output）
story export json --stdout | jq -c '.stories[] | {messages: [{role: "user", content: .summary}, {role: "assistant", content: .content}]}' > sft_data.jsonl

# 导出为 Embedding 训练格式
story export embeddings --stdout | jq -c '{text: .content, metadata: {title: .title, series: .series}}' > embedding_data.jsonl

# 快速分析数据配比（总字数/章节分布/重复短语）
story stats --json | jq '{words: .totalWords, chapters: .totalChapters, repeated: .analysis.repeated}'

💡 story-cli stellt sicher: UTF-8-Kodierung (GBK automatische Erkennung mit Warnung), Kapitel-Slicing (vermeidet semantische Unterbrechungen), vollständige Metadaten (type/series/summary können natürlich als Klassifikations-Tags verwendet werden). Kein zusätzliches Bereinigungsskript erforderlich.

🛠️ Häufige Befehle

Alle Befehlsaliase, Unterbefehle, Parameter und Kategorien findest du in docs/commands.md (zweisprachig Chinesisch/Englisch).

Benutzerdefinierte Geschichtstypen/Status und lokalisierte Tags:

{
  "types": ["original", "fanfic", "translation"],
  "statuses": ["completed", "ongoing", "planned"],
  "typeLabels": { "translation": { "zh": "翻译", "en": "Translation" } }
}

Die integrierten Enums enthalten bereits Tags, keine doppelte Konfiguration erforderlich. Das Löschen der Datei setzt auf die Standardwerte zurück.

📚 Dokumentation

⚠️ Kodierungsanforderungen

Alle Dateien müssen in UTF-8 kodiert sein. Bei Erkennung von GBK/GB2312 wird eine Warnung ausgegeben, aber der Build wird nicht blockiert.

🧪 Tests

make test         # 或 pnpm test

550+ Tests alle bestanden. Abgedeckt: Scanner, Seriengruppierung, Validierung, Template-Rendering, Wortzählung, Internationalisierung, README-Generierung, EPUB-Export, CLI-End-to-End (Smoke-Tests decken alle Befehle ab), .storyignore, MCP-Protokoll, JSON-Import, GitHub-Action-Struktur, Compliance-Prüfung, Verknüpfungsvorschläge, inkrementeller Build-Cache, Embeddings-Export usw.

☕ Sponsoring-Unterstützung

⚖️ License

MIT

🤝 Mitwirken

Wir freuen uns über Issues (Bug-Meldungen / Funktionsvorschläge, mit Formularvorlage); wenn du Code beitragen möchtest, lies bitte CONTRIBUTING.md und erfahre mehr über die Projektausrichtung in ROADMAP.md.