Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installing

Heph is a single binary, heph, built from the workspace with Cargo.

What you need

RequirementWhy
Rust 1.98+To build. Heph uses the 2024 edition and recent standard library.
git 2.40+Heph keeps its own git repository beside your project and merges with merge-tree.
rgRipgrep runs the grep and glob tools and lists files for search_replace.
A terminalThe interactive session takes the terminal over. heph exec works without one.
CredentialsAn Anthropic API key, or AWS credentials for Bedrock. The next chapter covers both.

Linux is where heph is developed and tested.

Build and install

From the workspace root:

cargo install --path crates/heph

That puts heph in ~/.cargo/bin. Check it:

heph --help

You should see the subcommands exec, wire-check, models, and tmux, and the flags the interactive session takes.

Optional tools

None of these are required, and heph does not check for them until you ask for one:

  • lazygit, vim-fugitive, or any tool that can stage and unstage hunks, if you would rather review changes there than in heph's own review screen (Review).
  • delta, difftastic, or another diff pager, to render diffs in the built-in review.
  • wl-paste or xclip, so Ctrl-V can attach an image from the clipboard.
  • tmux, for notifications in the status line and heph tmux next (Working in tmux).