Citadel

Manage your ebook library with Citadel. Backwards compatible with Calibre.

Screen.Recording.2024-04-24.at.22.47.16.mp4

Citadel is early software; it is likely full of bugs and lacking features.

Project goals

• Backwards compatible with Calibre: Calibre must be able to read any library that Citadel has edited.
• Good UX: Citadel must be easy to use and look good.
• Performant: Citadel must feel much faster than Calibre, and never slower.

Non-goals

• Ebook reader: Citadel is not an ebook reader. There are already excellent ereader apps: Citadel will open your files in your default apps.
• ...or editor: If you're editing ebook content (not metadata like titles), Citadel will not be a replacement for you.
• 100% feature parity: Primarily around Plugins, but there are some advanced features of Calibre we'll likely never build.

Downloading

Warning

Citadel is very early in development. It may crash, or be missing basic features. It may corrupt your ebook library.

Back up your Calibre library regularly if you use Citadel on it.

(Semi-) stable builds are available in Releases.

Development builds are available from GitHub actions.

Please report any issues or crashes you experience while using any version of Citadel!

Developing

As a prerequisite, you'll need to install Bun, Node¹, and Rust.

Then, you can install the packages.

bun install

and start up the app like so:

bun run dev
# or just bun dev

Lint & Formatting

To lint all source code, run bun lint. To autoformat, run bun format.

Scope	Action	Command
All code	Format	bun format
All code	Format (Check)	bun format:check
All code	Lint	bun lint
Backend	Format	bun format:backend
Backend	Lint	bun lint:backend
Frontend	Format	bun format:web
Frontend	Lint	bun lint:web

App preview without backend

You can run just the frontend with this command, although you WILL see errors as the Rust backend will be missing but is assumed to exist:

bun dev:app

To run the backend in server mode for development, run

bun dev -- -- -- -- --server --calibre-library=/path/to/calibre/library

Yes, that is 4 pairs of --s. This is because Bun will pass the first pair to another bun run command, the second will go to tauri dev, the third will go to vite dev, and finally the last set will go to Cargo when running the backend. It's a mess!

To run the backend in server mode for production, run

/Applications/Citadel.app/Contents/MacOS/Citadel --server --calibre-library=/path/to/calibre/library

Building

To create a production version of Citadel, you'll need the development prereqs. Then:

bun install
bun run build

Additional Credit & Related Projects

This project would not be possible without the north star created by Kovid Goyal, Calibre. Without his hard work building such an extensive and powerful tool, Citadel would not exist.

Huge thanks to Kemie Guaida, who created an excellent Calibre redesign Figma prototype, from which Citadel takes inspiration. Thank you, Kemie!

Footnotes

1. https://github.com/every-day-things/citadel/issues/9 ↩