Ekphos

An open source, lightweight, fast, terminal-based markdown research tool built with Rust.

Documentation

Go to docs.ekphos.xyz

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.70+
• For inline images: iTerm2, Kitty, WezTerm, Ghostty, or Sixel-compatible terminal

Discussion

• Open a discussion in the repository

Disclaimer

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

Contributing

git clone https://github.com/hanebox/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

To contribute to the documentation, see ekphos-docs.

License

MIT