Skip to content

Introduction

Hike Hike v0.10.0 │ContentLocalBookmarksHistory│/Users/davep/develop/python/hike/README.md │╸━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━│━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ││ │▼ Ⅰ Hike│ │├── Ⅱ Introduction│Installing │├── ▼ Ⅱ Installing│ ││   ├── Ⅲ pipx│pipx ││   ├── Ⅲ Homebrew│▇ ││   └── ▼ Ⅲ Other installation metho│The application can be installed using pipx: ││   └── Ⅳ X-CMD│ │├── Ⅱ Using Hike│ │├── ▼ Ⅱ Features│pipxinstallhike ││   └── Ⅲ Editing│ │├── Ⅱ File locations│ │├── Ⅱ Getting help│Homebrew │└── Ⅱ TODO│ ││The package is available via Homebrew. Use the following commands to ││install:▁ ││ ││ ││brewtapdavep/homebrew ││brewinstallhike ││ ││ ││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: ││ ││ ││xinstallhike ││ ││ > Enter a directory, file, path or command  f1 Help  f2 Nav  f5 Edit  f10 Quit  ^[ Backward  ^] Forward ▏^p Commands

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 such as GitHub, GitLab, Codeberg and Bitbucket.

Installation

pipx

The application can be installed using pipx:

pipx install hike

Homebrew

The package is available via Homebrew. Use the following commands to install:

brew tap davep/homebrew
brew install hike

Other installation methods

The following installation methods have been provided by third parties.

Warning

Please note that I don't maintain any of these installation methods and so can't vouch for them myself. I can't guarantee that they are up-to-date, neither can I guarantee that they install the original code.

Use them at your own risk.

X-CMD

The application can be installed using x-cmd:

x install hike

Running Hike

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

Command line options

Hike has a number of command line options; they include:

-b, --bindings

Prints the application commands whose keyboard bindings can be modified, giving the defaults too.

hike --bindings

Backward - Move backward through history
    Default: ctrl+left_square_bracket
BookmarkLocation - Bookmark the current location
    Default: ctrl+b
ChangeCommandLineLocation - Swap the position of the command line between top and bottom
    Default: ctrl+up, ctrl+down
ChangeNavigationSide - Change which side the navigation panel lives on
    Default: shift+f2
ChangeTheme - Change the application's theme
    Default: f9
CopyLocationToClipboard - Copy the location to the clipboard
    Default: f4
CopyMarkdownToClipboard - Copy the Markdown source to the clipboard
    Default: shift+f4
Edit - Edit the current markdown document
    Default: f5
Forward - Move forward through history
    Default: ctrl+right_square_bracket
Help - Show help for and information about the application
    Default: f1, ?
JumpToBookmarks - Jump to the bookmarks in the navigation panel
    Default: ctrl+o
JumpToCommandLine - Jump to the command line
    Default: /
JumpToDocument - Jump to the markdown document
    Default: ctrl+slash, ctrl+g
JumpToHistory - Jump to the history in the navigation panel
    Default: ctrl+y
JumpToLocalBrowser - Jump to the local filesystem browser in the navigation panel
    Default: ctrl+l
JumpToTableOfContents - Jump to the table of contents in the navigation panel
    Default: ctrl+t
Quit - Quit the application
    Default: f10, ctrl+q
Reload - Reload the current document
    Default: ctrl+r
SaveCopy - Save a copy of the current document
    Default: ctrl+s
SearchBookmarks - Search the bookmarks
    Default: f3
ToggleNavigation - Show/hide the navigation panel
    Default: f2

-h, --help

Prints the help for the hike command.

hike --help

usage: hike [-h] [-v] [--license] [-b] [--navigation | --no-navigation]
            [-t THEME]
            [command ...]

Hike -- A Markdown viewer for the terminal.

positional arguments:
  command               The initial command; can be any valid input to Hike's
                        command line.

options:
  -h, --help            show this help message and exit
  -v, --version         Show version information
  --license, --licence  Show license information
  -b, --bindings        List commands that can have their bindings changed
  --navigation, --no-navigation
                        Show or hide the navigation panel on startup
  -t, --theme THEME     Set the theme for the application (set to ? to list
                        available themes)

v0.10.0

--license, --licence

Prints a summary of Hike's license.

hike --license

Hike - A Markdown viewer for the terminal.  
Copyright (C) 2025 Dave Pearson

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.

--navigation

Starts Hike with the navigation panel visible; this overrides and modifies the saved state of the navigation panel.

--no-navigation

Starts Hike with the navigation panel hidden; this overrides and modifies the saved state of the navigation panel.

-t, --theme

Sets Hike's theme; this overrides and changes any previous theme choice made via the user interface.

To see a list of available themes use ? as the theme name:

hike --theme=?

catppuccin-latte
catppuccin-mocha
dracula
flexoki
gruvbox
monokai
nord
solarized-light
textual-dark
textual-light
tokyo-night

-v, --version

Prints the version number of Hike.

hike --version

hike v0.10.0

The startup command

Hike can also take a command on the command line, which will be processed via its own internal command line. This means that you have access to the full array of Hike features. This means you can do something as simple as give the name of a file to view:

hike view-this.md

or you can view a README file hosted on a forge:

hike gh davep/org-davep-2bit

Getting help

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

The Hike Help Screen Hike v0.10.0 │/Users/davep/develop/python/hike/README.md │━━━━━━━━━━━━━━┌─ Help ─────────────────────────────────────────────────────────────────────────────────┐━━━━━━━━━━━━━━━ │││ │││ │││ ││Hike 0.10.0│ │🖼  Hike││ │││ │🖼  GitHub Ac││ests🖼 │GitHub Relea│Command Line│ │││ ││Use this command line to enter filenames, directories, URLs or commands. Entering a│ │Introduction│filename or a URL will open that file for viewing; entering a directory will open a│ ││file opening dialog starting at that location.▄│ │Hike is a Ma││down files, │as well as M││ to view │Markdown fil│Command    Aliases    Arguments     Description                               │ ││ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ │ ││<directory>Open a file browser looking at <directory>│ │Installing│<file>View the file at <file>│ ││<url>View the file at <url>│ │pipx│bitbucketbb<remote-file>¹Open a file from Bitbucket                │▇ ││bookmarksb, bmJump to the bookmarks                     │ │The applicat│changelogclShow Hike's ChangeLog                     │ ││chdircd, dir, ls<directory>Change the root directory of the local    │ ││file browser                              │ │pipxinsta│codebergcb<remote-file>¹Open a file from Codeberg                 │ ││contentsc, tocJump to the table of contents             │ ││documentd, docJump to the markdown document             │ │Homebrew│githubgh<remote-file>¹Open a file from GitHub                   │ ││gitlabgl<remote-file>¹Open a file from GitLab                   │ │The package │help?Show the help screen                      │ ││historyhJump to the browsing history              │ ││locallJump to the local file browser            │ │brewtapd│obsidianobsChange the root directory to your Obsidian│ │brewinsta│vaults                                    │ ││quitqQuit the application                      │ ││readmeShow Hike's README                        │ │Other instal││ │││ │The followin│¹Forge support│ for them │myself so us│────────────────────────────────────────────────────────────────────────────────────────│ ││▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔│ │X-CMD│ Okay [Esc]│ ││▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁│ │The applicat└────────────────────────────────────────────────────────────────────────────────────────┘ │ > Enter a directory, file, path or command  f1 Help  f2 Nav  f5 Edit  f10 Quit  ^[ Backward  ^] Forward ▏^p Commands

The help will adapt to which part of the screen has focus, providing extra detail where appropriate; so while the example shown above shows the help related to Hike's command line, here's the help when the markdown document has focus:

Markdown Document Help Hike v0.10.0 │/Users/davep/develop/python/hike/README.md │━━━━━━━━━━━━━━┌─ Help ─────────────────────────────────────────────────────────────────────────────────┐━━━━━━━━━━━━━━━ │││ │││ │││ ││Hike 0.10.0│ │🖼  Hike││ │││ │🖼  GitHub Ac││ests🖼 │GitHub Relea│Movement│ │││ ││As well as using the common set of cursor and page keys, the following keys are│ │Introduction│available for movement within the markdown document:│ │││ │Hike is a Ma││down files, │as well as M│Key                          Description                                        │ to view │Markdown fil│ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ │ ││shift+pgdn, d                Scroll down half a page                            ▅│ ││j, e, ⏎                      Scroll down one line                               │ │Installing│f, space, z                  Scroll down one page                               │ ││G, >                         Scroll to the bottom                               │ │pipx│g, <, p, %                   Scroll to the top                                  │▇ ││shift+pgup, u                Scroll up half a page                              │ │The applicat│k, y                         Scroll up one line                                 │ ││b, w                         Scroll up one page                                 │ │││ │pipxinsta││ │││ ││Viewer│ │Homebrew││ ││This is the main Markdown viewer.│ │The package ││ ││Copying to the clipboard│ │││ │brewtapd│See the main help and the command palette for commands for copying to the clipboard;│ │brewinsta│you can also copy with the mouse by either clicking once while holding down ctrl, or│ ││click 3 times. Doing so on the location will copy the location, doing so on the main│ ││document will copy the markdown's source.│ │Other instal││ ││Locally-useful keys include:│ │The followin││ for them │myself so us│────────────────────────────────────────────────────────────────────────────────────────│ ││▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔│ │X-CMD│ Okay [Esc]│ ││▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁│ │The applicat└────────────────────────────────────────────────────────────────────────────────────────┘ │ > Enter a directory, file, path or command  f1 Help  f2 Nav  f5 Edit  f10 Quit  ^[ Backward  ^] Forward ▏^p Commands

The command palette

Another way of discovering commands and keys in Hike is to use the command palette (by default you can call it with ctrl+p or meta+x).

The Hike Command Palette Hike v0.10.0 │/Users/davep/develop/python/hike/README.md │━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ │▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔ │ │Search for commands… │ │🖼  Hike │Backward [^[] │🖼  GitHub AcMove backward through historyests🖼 │GitHub ReleaBookmark Location [^b] │Bookmark the current location │Change Command Line Location [^↑] │IntroductionSwap the position of the command line between top and bottom │Change Navigation Side [shift+f2] │Hike is a MaChange which side the navigation panel lives ondown files, │as well as MChange Theme [f9] to view │Markdown filChange the application's theme │Copy Location To Clipboard [f4] │Copy the location to the clipboard │InstallingCopy Markdown To Clipboard [shift+f4] │Copy the Markdown source to the clipboard │pipxEdit [f5]▇ │Edit the current markdown document │The applicatHelp [f1] │Show help for and information about the application │Jump To Bookmarks [^o] │pipxinstaJump to the bookmarks in the navigation panel │Jump To Command Line [/] │Jump to the command line │HomebrewJump To Document [^/] │Jump to the markdown document │The package Jump To History [^y] │Jump to the history in the navigation panel │Jump To Local Browser [^l] │brewtapdJump to the local filesystem browser in the navigation panel▆ │brewinstaJump To Table Of Contents [^t] │Jump to the table of contents in the navigation panel │Quit [f10] │Other instalQuit the application │Reload [^r] │The followin▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ for them │myself so use them at your own risk. │ │X-CMD │ │The application can be installed using x-cmd: │ > Enter a directory, file, path or command  f1 Help  f2 Nav  f5 Edit  f10 Quit  ^[ Backward  ^] Forward ▏^p Commands

Questions and feedback

If you have any questions about Hike, or you have ideas for how it might be improved, do please feel free to visit the discussion area and ask your question or suggest an improvement.

When doing so, please do search past discussions and also issues current and previous to make sure I've not already dealt with this, or don't have your proposed change already flagged as something to do.