Hike

Introduction

Hike is a Markdown browser for the terminal. It provides the ability to browse for and view local Markdown files, as well as Markdown files that can be downloaded from the web. It also has shortcuts that make it easy to view Markdown files on popular git forges.

Installing

pipx

The application can be installed using pipx:

pipx install hike

uv

The package can be install using uv:

uv tool install hike

If you don't have uv installed you can use uvx.sh to perform the installation. For GNU/Linux or macOS or similar:

curl -LsSf uvx.sh/hike/install.sh | sh

or on Windows:

powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/hike/install.ps1 | iex"

Other installation methods

The following installation methods have been provided by third parties; please note that I can't vouch for them myself so use them at your own risk.

X-CMD

The application can be installed using x-cmd:

x install hike

Using Hike

Once you've installed Hike using one of the above methods, you can run the application using the hike command.

The best way to get to know Hike is to read the help screen. Once in the application you can see this by pressing F1.

Commands can also be discovered via the command palette (ctrl+p):

For more information and details on configuring Hike, see the online documentation.

Features

• A command line where file names, URLs and commands can be entered.
• A local file browser.
• A simple bookmarking system.
• A browsing history.
• The ability to edit markdown documents in the local filesystem, either using your editor of choice or a simple builtin editor.
• Commands for quickly loading and viewing files held on GitHub, GitLab, Codeberg and Bitbucket.
• A command palette to make it easy to discover commands and their keys.
• A rich help screen to make it easy to discover commands and their keys.
• Possibly more as time goes on.

Editing

As mentioned above, Hike has support for editing markdown documents you're viewing from the local filesystem. While a builtin editor is provided, use of your own choice of editor is supported. If Hike finds that $VISUAL or $EDITOR are set in your environment then the resulting command will be used to edit the document (with $VISUAL being tried first, followed by $EDITOR).

File locations

Hike stores files in a hike directory within both $XDG_DATA_HOME and $XDG_CONFIG_HOME. If you wish to fully remove anything to do with Hike you will need to remove those directories too.

Expanding for the common locations, the files normally created are:

• ~/.config/hike/configuration.json -- The configuration file.
• ~/.local/share/hike/*.json -- The locally-held data.

Getting help

If you need help, or have any ideas, please feel free to raise an issue or start a discussion.

TODO

See the TODO tag in issues to see what I'm planning.