# Hike
## Introduction
Hike is a [Markdown](https://commonmark.org/help/) 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 east to view Markdown files on popular git forges.
## Installing
### pipx
The application can be installed using [`pipx`](https://pypa.github.io/pipx/):
```sh
$ pipx install hike
```
Once installed run the `hike` command.
### Homebrew
The package is available via Homebrew. Use the following commands to install:
```sh
$ brew tap davep/homebrew
$ brew install hike
```
Once installed run the `hike` command.
## Using Hike
The best way to get to know Hike is to read the help screen. Once in the
application you can see this by pressing <kbd>F1</kbd>.
Commands can also be discovered via the command palette
(<kbd>ctrl</kbd>+<kbd>p</kbd>):
## 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](https://github.com/davep/hike/issues?q=is%3Aissue+is%3Aopen+label%3ATODO).
### 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`](https://specifications.freedesktop.org/basedir-spec/latest/).
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](https://github.com/davep/hike/issues) or [start a
discussion](https://github.com/davep/hike/discussions).
## TODO
See [the TODO tag in
issues](https://github.com/davep/hike/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)
to see what I'm planning.
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": null,
"name": "hike",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "chui, documentation, file-browser, file-viewer, markdown, markdown-viewer, terminal, tui",
"author": null,
"author_email": "Dave Pearson <davep@davep.org>",
"download_url": "https://files.pythonhosted.org/packages/eb/d2/1b270451b0f857c25b1a842a994efae310becd4f67470db4bfd6b0224eaf/hike-0.2.0.tar.gz",
"platform": null,
"description": "# Hike\n\n\n\n## Introduction\n\nHike is a [Markdown](https://commonmark.org/help/) browser for the terminal.\nIt provides the ability to browse for and view local Markdown files, as well\nas Markdown files that can be downloaded from the web. It also has shortcuts\nthat make it east to view Markdown files on popular git forges.\n\n## Installing\n\n### pipx\n\nThe application can be installed using [`pipx`](https://pypa.github.io/pipx/):\n\n```sh\n$ pipx install hike\n```\n\nOnce installed run the `hike` command.\n\n### Homebrew\n\nThe package is available via Homebrew. Use the following commands to install:\n\n```sh\n$ brew tap davep/homebrew\n$ brew install hike\n```\n\nOnce installed run the `hike` command.\n\n## Using Hike\n\nThe best way to get to know Hike is to read the help screen. Once in the\napplication you can see this by pressing <kbd>F1</kbd>.\n\n\n\nCommands can also be discovered via the command palette\n(<kbd>ctrl</kbd>+<kbd>p</kbd>):\n\n\n\n## Features\n\n- A command line where file names, URLs and commands can be entered.\n- A local file browser.\n- A simple bookmarking system.\n- A browsing history.\n- The ability to edit markdown documents in the local filesystem, either\n using your editor of choice or a simple builtin editor.\n- Commands for quickly loading and viewing files held on GitHub, GitLab,\n Codeberg and Bitbucket.\n- A command palette to make it easy to discover commands and their keys.\n- A rich help screen to make it easy to discover commands and their keys.\n- [Possibly more as time goes on](https://github.com/davep/hike/issues?q=is%3Aissue+is%3Aopen+label%3ATODO).\n\n### Editing\n\nAs mentioned above, Hike has support for editing markdown documents you're\nviewing from the local filesystem. While a builtin editor is provided, use\nof your own choice of editor is supported. If Hike finds that `$VISUAL` or\n`$EDITOR` are set in your environment then the resulting command will be\nused to edit the document (with `$VISUAL` being tried first, followed by\n`$EDITOR`).\n\n## File locations\n\nHike stores files in a `hike` directory within both\n[`$XDG_DATA_HOME` and\n`$XDG_CONFIG_HOME`](https://specifications.freedesktop.org/basedir-spec/latest/).\nIf you wish to fully remove anything to do with Hike you will need to\nremove those directories too.\n\nExpanding for the common locations, the files normally created are:\n\n- `~/.config/hike/configuration.json` -- The configuration file.\n- `~/.local/share/hike/*.json` -- The locally-held data.\n\n## Getting help\n\nIf you need help, or have any ideas, please feel free to [raise an\nissue](https://github.com/davep/hike/issues) or [start a\ndiscussion](https://github.com/davep/hike/discussions).\n\n## TODO\n\nSee [the TODO tag in\nissues](https://github.com/davep/hike/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)\nto see what I'm planning.\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"summary": "A Markdown browser for the terminal",
"version": "0.2.0",
"project_urls": {
"Discussions": "https://github.com/davep/hike/discussions",
"Documentation": "https://github.com/davep/hike/blob/main/README.md",
"Homepage": "https://github.com/davep/hike",
"Issues": "https://github.com/davep/hike/issues",
"Repository": "https://github.com/davep/hike",
"Source": "https://github.com/davep/hike"
},
"split_keywords": [
"chui",
" documentation",
" file-browser",
" file-viewer",
" markdown",
" markdown-viewer",
" terminal",
" tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "089dc30db02587f599a4258bb74ec9be1c0a90835df6d534d4e67559b5ac1d0f",
"md5": "85be03f41a69ae67c43faabc2401af8a",
"sha256": "64a2964f150f89cf0610dd64f4c3430dde6b602d05221fde5dd2273c38e3d1f8"
},
"downloads": -1,
"filename": "hike-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85be03f41a69ae67c43faabc2401af8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 57409,
"upload_time": "2025-02-16T15:42:29",
"upload_time_iso_8601": "2025-02-16T15:42:29.588195Z",
"url": "https://files.pythonhosted.org/packages/08/9d/c30db02587f599a4258bb74ec9be1c0a90835df6d534d4e67559b5ac1d0f/hike-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ebd21b270451b0f857c25b1a842a994efae310becd4f67470db4bfd6b0224eaf",
"md5": "2066e585abe94a3e4126d32c775c6a5d",
"sha256": "bb8b045dc76a153cb06ae74a5370a7393363f7cb7899f5620370412f7516c838"
},
"downloads": -1,
"filename": "hike-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2066e585abe94a3e4126d32c775c6a5d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 708862,
"upload_time": "2025-02-16T15:42:31",
"upload_time_iso_8601": "2025-02-16T15:42:31.945075Z",
"url": "https://files.pythonhosted.org/packages/eb/d2/1b270451b0f857c25b1a842a994efae310becd4f67470db4bfd6b0224eaf/hike-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-16 15:42:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "hike",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hike"
}
JSON
