Ekphos

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

Installation

Using Make

git clone https://github.com/hanebox/ekphos.git
cd ekphos
make
sudo make install

Using Cargo

cargo install ekphos

Uninstall

If installed with Make

sudo make uninstall

If installed with Cargo

cargo uninstall ekphos

Remove config (optional)

rm -rf ~/.config/ekphos

Configuration

Configuration is stored in ~/.config/ekphos/config.toml.

# General settings
theme = "catppuccin-mocha"
notes_dir = "~/notes"

# Keybinds
[keybinds]
quit = "q"
edit = "e"
save = "ctrl+s"
navigate_up = "k"
navigate_down = "j"
switch_focus = "tab"

Themes

Themes are stored in ~/.config/ekphos/themes/.

Default Themes

• catppuccin-mocha (default)
• catppuccin-latte
• catppuccin-frappe
• catppuccin-macchiato

Custom Themes

Create a .toml file in the themes directory:

# ~/.config/ekphos/themes/mytheme.toml
name = "mytheme"

[colors]
base = "#1e1e2e"
surface0 = "#313244"
text = "#cdd6f4"
subtext0 = "#a6adc8"
overlay0 = "#6c7086"
lavender = "#b4befe"
peach = "#fab387"
green = "#a6e3a1"
red = "#f38ba8"
yellow = "#f9e2af"

Then set in config:

theme = "mytheme"

Usage

Layout

Ekphos has three panels:

• Sidebar (left): List of notes
• Content (center): Note content with markdown rendering
• Outline (right): Auto-generated headings for quick navigation

Use Tab to switch between panels.

Creating Notes

1. Press n to create a new note
2. Enter the note name
3. Press Enter to confirm

Notes are stored as .md files in your configured notes directory.

Deleting Notes

1. Select the note in the sidebar
2. Press d to delete
3. Confirm with y or cancel with n

Editing Notes

1. Select a note in the sidebar
2. Press e to enter edit mode
3. Edit using vim keybindings
4. Press Ctrl+s to save
5. Press Esc to exit edit mode

Vim Keybindings (Edit Mode)

Visual Mode

Press v in normal mode to enter visual mode for text selection.

Supported Markdown

Adding Images

Use standard markdown image syntax:

![alt text](path/to/image.png)
![screenshot](~/pictures/screenshot.png)
![diagram](./diagrams/flow.png)

Supported formats: PNG, JPEG, GIF, WebP, BMP

Viewing Images

1. Navigate to the image line in content view
2. Press Enter or o to open in system viewer

Terminal Image Support

For inline image preview, use a compatible terminal:

• iTerm2 (macOS)
• Kitty
• WezTerm
• Sixel-enabled terminals

Using the Outline

The outline panel shows all headings in your note:

1. Press Tab to focus the outline
2. Use j/k to navigate headings
3. Press Enter to jump to that heading

Keyboard Shortcuts

Contributing

Ekphos is open source and contributions are welcome.

git clone https://github.com/hanebox/ekphos.git
cd ekphos
make run

License

MIT