Hike Overview
Hike is a terminal-first Markdown browser with a local file browser, forge shortcuts, a responsive TUI, and a command-driven workflow. This repository is the Tobias Hochguertel fork of the original davep/hike project.
What this docs site covers
Section titled “What this docs site covers”This site is organized around the workflows people actually need:
- Getting Started for installation and first commands
- Viewing & Navigation for the TUI interaction model
- CLI Reference for the external Typer command tree
- In-App Command Line for the command line inside the TUI
- Configuration for YAML, env files, schemas, and UI behavior
- Project pages for licensing and release history
Why this fork is different
Section titled “Why this fork is different”Compared with upstream, this fork focuses on:
- a typed Typer CLI with
open,config,schema,env,bindings, andthemes - YAML configuration plus
.envand schema workflows - a configurable local browser with tree and flat-list modes
- responsive navigation behavior on narrow terminals
- keybinding sets and richer startup behavior
Quick orientation
Section titled “Quick orientation”| Start here if you want to… | Read this next |
|---|---|
| install or update Hike | Getting Started |
understand hike open | CLI Overview then open |
| learn how the sidebar and startup selection work | Viewing & Navigation |
| customize startup, keybindings, or layout | Configuration Overview |
| inspect the in-app command language | In-App Command Line |