MagicZhang/fanfic-archivist-cli
MagicZhang/fanfic-archivist-cli
Watch
1
1
Fork
You've already forked fanfic-archivist-cli
 0
Code Issues Pull requests Projects Releases Wiki Activity Actions
Terminal client for the FicHub companion bot: search, quote, download, body-search, bookmarks, personalized recs, ask, link/updates/status — colored TTY or JSON over the FicHub REST API. Renders archivist-core PlatformMessage IR.
2 commits 1 branch 0 tags 96 KiB
  • Rust 100%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
MagicZhang a814cef6f4 docs: add reddit + forum announcement drafts for fic-archivist CLI 
r/rust and r/cli ready-to-post drafts (no reddit automation — post
manually via the submit URLs). Forum announcement already posted live
2026-08-16 (topic 4, general).
2026-08-16 20:12:33 +02:00
docs docs: add reddit + forum announcement drafts for fic-archivist CLI 2026-08-16 20:12:33 +02:00
src feat: standalone CLI crate (fic-archivist) for the FicHub companion bot 2026-08-16 20:07:37 +02:00
.gitignore feat: standalone CLI crate (fic-archivist) for the FicHub companion bot 2026-08-16 20:07:37 +02:00
Cargo.lock feat: standalone CLI crate (fic-archivist) for the FicHub companion bot 2026-08-16 20:07:37 +02:00
Cargo.toml feat: standalone CLI crate (fic-archivist) for the FicHub companion bot 2026-08-16 20:07:37 +02:00
LICENSE feat: standalone CLI crate (fic-archivist) for the FicHub companion bot 2026-08-16 20:07:37 +02:00
README.md feat: standalone CLI crate (fic-archivist) for the FicHub companion bot 2026-08-16 20:07:37 +02:00

README.md

fanfic-archivist-cli

Terminal client for the FicHub companion bot ("the Archivist") — a self-hosted fanfiction archive with 107-site scraper parity, pluggable recommendations, full-text body search, an LLM "Ask the Archive", a Fic Requests board, and a Roadmap consensus arena.

This crate is the CLI front-end (fic-archivist binary) over the platform-neutral archivist-core library. It renders PlatformMessage IR as colored TTY output (or JSON) and ships a WebSocket module as a seam for a future FicHub web-chat route.

Install

cargo install fic-archivist --version 0.2.0

Or build from source:

git clone https://opencommit.eu/MagicZhang/fanfic-archivist-cli.git
cd fanfic-archivist-cli
cargo build --release   # binary at target/release/fic-archivist

Configure

The CLI talks only to the FicHub REST API. Set FANFIC_ARCHIVIST_BASE_URL to your instance (default https://fichub.polarisocial.xyz):

export FANFIC_ARCHIVIST_BASE_URL=https://fichub.polarisocial.xyz
fic-archivist --help

Config file: ~/.config/fichub/config.toml.

Commands

  • search — search the archive
  • quote — fetch fic metadata by URL
  • download — download a fic (EPUB/PDF/MOBI/...)
  • body-search — full-text body search
  • bookmarks — your bookmarks
  • recs — personalized recommendations
  • ask — LLM "Ask the Archive"
  • link / updates / status — bot pairing + update feed
  • REPL mode — interactive shell with the same commands

Run fic-archivist --help for the full command list.

License

AGPL-3.0-or-later. See LICENSE.

Related

  • archivist-core — the platform-neutral core crate (REST client, dispatch, intent, cache)
  • fanfic-archivist — the multi-platform bot workspace (Discord, Matrix, Telegram, Slack, IRC, fediverse, CLI)
  • fanfic-scrapers — the scraper crate with 107-site parity
  • fichub — the FicHub archive server itself