Getting Started
Install ekphos and create your first notes
Installation
Don't have Rust? Run curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh to install it.
The recommended way to install ekphos:
cargo install ekphosTo update:
cargo install ekphosTo uninstall:
cargo uninstall ekphosFirst Run
Create your first note
Press n in the sidebar to create a new note. Enter a name and press Enter.
Start editing
Press e to enter edit mode. Use vim keybindings to write your note.
Press Ctrl+s to save.
Interface Overview
Ekphos has a three-panel layout:
| Panel | Purpose | Toggle |
|---|---|---|
| Sidebar (left) | File tree navigation | Ctrl+b |
| Content (center) | Markdown preview/edit | - |
| Outline (right) | Heading navigation | Ctrl+o |
Use Tab to switch focus between panels.
Essential Keybindings
| Key | Action |
|---|---|
n | New note |
N | New folder |
t | Open today's journal |
e | Edit note |
d | Delete |
/ | Search notes (sidebar) |
Ctrl+k | Quick open (files & content search) |
Ctrl+f | Find in buffer |
Ctrl+z | Toggle zen mode |
? | Help |
q | Quit |
Press ? at any time to see the full keybindings reference.
Configuration
Ekphos stores configuration at ~/.config/ekphos/config.toml. Notes are stored in ~/Documents/ekphos by default.
After major updates, run ekphos --reset to reset configuration if you encounter issues.
Next Steps
- Learn all keybindings
- Start a daily journal with a single keystroke
- Master search with instant full-text indexing
- Customize your configuration
- Explore markdown features
- Create custom themes