Ekphos

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

Go to Documentation

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.

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

Press F6 to choose Standard, Vim, or Helix when editing a Markdown note. The choice is saved for future sessions. You can also set it in your config file:

[editor]
mode = "helix"

Helix mode uses selections as cursors. Use v to extend selections, C to add a cursor below, % to select the note, and s to select regex matches within the current selections. Press i or a to insert, Esc to return to Normal mode, and F1 for key help. In Helix mode, :w saves without leaving the editor, :wq saves and returns to preview, and :q returns to preview after checking for unsaved changes.

Helix shortcuts take priority while editing. For example, Ctrl+S saves a selection to the jump list; use :w to save the note. Space f opens the note picker and Space / opens content search after saving any edits. Features that need language servers, tree-sitter, split windows, or shell integration are not available in Ekphos.

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

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

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

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.

MIT