Getting Started

Recommended install methods

Install Python 3.13 and uv with mise or ensure you already have uv available.

Install this fork from the main branch:

uv tool install --force "git+https://github.com/tobiashochguertel/hike.git@main"

Confirm the CLI is available:
Terminal window
```
hike --version
```

`mise` + `uv`

mise use -g python@3.13 uv@latest
uv tool install --force "git+https://github.com/tobiashochguertel/hike.git@main"

Direct `uv`

uv tool install --force "git+https://github.com/tobiashochguertel/hike.git@main"

Alternatives

If you prefer pipx:

pipx install "git+https://github.com/tobiashochguertel/hike.git@main"

If you are working from source:

git clone https://github.com/tobiashochguertel/hike.git
cd hike
git switch main
uv sync --group dev
uv run hike --help

First commands

These are the most useful first invocations:

hike open
hike open README.md
hike open docs/
hike open https://example.com/README.md
hike config init
hike bindings sets
hike themes list
hike --version

What `hike open` does

hike open is the main entry point into the TUI:

with a file, Hike opens that file immediately
with a directory, Hike roots the local browser there and auto-opens a preferred document
with a URL, Hike loads the remote Markdown document directly
with no target, Hike starts from the configured local browser root, which is the current working directory by default

By default Hike prefers INDEX.md, then README.md, then the first visible Markdown file in local-browser order.