Ekphos

A lightweight, fast, terminal-based markdown research tool built with Rust.

Documentation

Go to Documentation

Quick Start

To install with Cargo:

cargo install ekphos

Alternatively, you can install Ekphos using Homebrew:

brew install ekphos

Or using AUR:

yay -S ekphos

Note: Always update to the latest version. If you encounter config issues after updating, run ekphos --reset to reset your configuration.

Requirements

• Rust 1.90+
• For inline images and graphical equations: iTerm2, Kitty, WezTerm, Ghostty, or a Sixel-compatible terminal

Building from source

make verify                 # format, check, Clippy, tests, release, packages
make dist                   # platform release archive
nix build .#default         # Nix package
docker build -t ekphos .    # Linux container

Community

• Join the nostacks Discord for help, ideas, conversations, and project updates

Disclaimer

This project is in early development. There may be breaking changes and bugs in pre-releases.

Contributing

git clone https://github.com/nostacks/ekphos.git
cd ekphos

1. Fork the repository
2. Create a feature branch from main
3. Make your changes
4. Submit a PR to the main branch

Read the Ekphos documentation.

License

MIT