Getting Started

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 ekphos

To update:

cargo install ekphos

To uninstall:

cargo uninstall ekphos

An alternative way to install ekphos:

brew install ekphos

To update:

brew upgrade ekphos

To uninstall:

brew uninstall ekphos

Clone and build from source:

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

To uninstall:

sudo make uninstall

Run ekphos in a Docker container with SSH access:

git clone https://github.com/hanebox/ekphos.git
cd ekphos
docker build -t ekphos-ssh .
docker compose up -d

Connect via SSH:

ssh ekphos@localhost

ekphos

Or open a specific folder:

ekphos ~/notes

Press n in the sidebar to create a new note. Enter a name and press Enter.

Press e to enter edit mode. Use vim keybindings to write your note. Press Ctrl+s to save.

Ekphos has a three-panel layout:

Use Tab to switch focus between panels.

Key	Action
`n`	New note
`N`	New folder
`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.

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.