Skip to content

Latest commit

 

History

61 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FictionOps

FictionOps CI

FictionOps is a local-first CLI workflow system for maintaining long-form fiction projects: outlines, chapter plans, canon, character memory, foreshadowing, information boundaries, AI-assisted task bundles, review gates, and publishable EPUB/Markdown outputs.

It is not a one-click novel generator. It is a project harness for writers who want a large story to stay readable, auditable, and alive across many chapters.

Why It Exists

Long novels are not just prose files. They accumulate promises, secrets, false leads, character memory, revision decisions, and publishing artifacts. FictionOps keeps those moving parts in ordinary files and gives you CLI checks before the story drifts out of sync.

Use it when you need to:

  • migrate a messy existing novel folder into a maintainable structure;
  • plan books, chapters, scenes, and draft briefs;
  • audit continuity, information release, character files, repeated wording, table structure, and chapter length rhythm;
  • hand a bounded task to an AI model or external runner without letting it overwrite canon or manuscript files;
  • export clean Markdown, metadata, manifests, and EPUB packages.

30 Second Quick Start

FictionOps quickstart terminal preview

Install from the GitHub source checkout today:

python -m pip install "git+https://github.com/SouthWinter/fictionops.git#subdirectory=fictionops"

After the first formal PyPI release, the intended install command is:

python -m pip install fictionops

Create a tiny project:

fictionops init my-novel --title "My Novel"
fictionops new-book my-novel --book book_01 --title "Book One"
fictionops new-chapter my-novel --book book_01 --chapter 001 --title "Chapter One"
fictionops plan-chapter my-novel --book book_01 --chapter 001
fictionops draft-brief my-novel --book book_01 --chapter 001
fictionops doctor my-novel --book book_01

Run the bundled demo from a clone:

git clone https://github.com/SouthWinter/fictionops.git
cd fictionops/fictionops/examples/demo_novel
fictionops plan-chapter . --chapter 002 --force
fictionops scene-plan . --chapter 002
fictionops draft-brief . --chapter 002 --include-context-content --max-total-chars 4000
fictionops agent-run . --role draft-writer --chapter 002 --out-dir 00_management/agent_runs/ch_002_demo --force
fictionops agent-exec 00_management/agent_runs/ch_002_demo --runner python ../../examples/agent_runner_echo.py
fictionops agent-inbox . --format json

AI/API Integration

FictionOps core does not call models and does not store API keys. It prepares task bundles and saves staged output. External runners do the provider call.

Dry-run an OpenAI-compatible provider such as DeepSeek:

fictionops agent-exec my-novel/00_management/agent_runs/ch_001 \
  --runner python fictionops/examples/agent_runner_openai_chat.py \
  --dry-run \
  --model deepseek-chat \
  --api-key-env DEEPSEEK_API_KEY \
  --base-url https://api.deepseek.com

The same runner can be used with Qwen/DashScope, Kimi/Moonshot, GLM/Zhipu, Doubao/Volcengine Ark, SiliconFlow, OpenAI-compatible local servers, and similar providers. See model providers.

Documentation

Project Layout

fictionops/
  pyproject.toml
  src/fictionops/       # CLI implementation
  docs/                 # user, agent, release, and compatibility docs
  examples/             # demo novel, legacy migration sample, runner/controller examples
  tests/                # regression tests

Roadmap

The current package is a 0.1.1 pre-alpha onboarding and packaging candidate with 51 CLI commands and 129 regression tests. Near-term work focuses on:

  • formal PyPI release;
  • clearer demo media and short tutorials;
  • real-project migration dogfood;
  • controller-loop hardening;
  • documentation parity for outside contributors;
  • long-term 1.0 compatibility evidence.

See the full roadmap and milestone status.

Research Framing

FictionOps can also be treated as a local-first evaluation harness for long-horizon writing agents: persistent workspace state, scoped context construction, staged model outputs, human review gates, continuity audits, and controller-loop traces. fictionops eval-agent can generate a no-network smoke report for that harness on a temporary fixture copy. See the agent evaluation protocol for baseline conditions, benchmark tasks, and metrics, and the demo report for a first reproducible evidence record.

Contributing

Contributions, bug reports, documentation fixes, and workflow feedback are welcome. Start with CONTRIBUTING.

Citation

If FictionOps helps your writing workflow, research, article, or agent experiment, cite it using CITATION.cff.

License

FictionOps is released under the MIT License.

About

Local-first CLI workflow system for long-form fiction, AI-assisted writing boundaries, audits, and publishing.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages