https://github.com/lusingander/topi

Terminal OpenAPI documentation viewer 🐐
https://github.com/lusingander/topi

bubbletea go openapi openapi-specification openapi3 tui

Last synced: about 2 months ago
JSON representation

Terminal OpenAPI documentation viewer 🐐

• Host: GitHub
• URL: https://github.com/lusingander/topi
• Owner: lusingander
• License: mit
• Created: 2022-02-26T23:31:07.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-06-26T07:46:46.000Z (over 2 years ago)
• Last Synced: 2024-10-31T10:51:27.763Z (about 2 months ago)
• Topics: bubbletea, go, openapi, openapi-specification, openapi3, tui
• Language: Go
• Homepage:
• Size: 710 KB
• Stars: 18
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# topi

Terminal OpenAPI documentation viewer 🐐

## About

> topi is still under development... 🐐

topi is the documentation viewer for OpenAPI v3 definitions in the terminal.



(This image show https://github.com/github/rest-api-description)

## Installation

`$ go install github.com/lusingander/topi@latest`

(require Go 1.18+)

## Usage

`$ topi `

> `path` can be local file path or remote URL.

### Keybindings

#### Common

common keybindings for all pages

|Key|Description|

|-|-|

|Backspace|back to perv page|

|Ctrl+c|quit|

|?|show help page|

#### List page

keybindings for list-syle pages 

|Key|Description|

|-|-|

|j|cursor down|

|k|cursor up|

|f l|next page|

|b h|prev page|

|g|go to start|

|G|go to end|

|/|Enter filtering mode|

|Enter|(default) select item, (filtering) apply filter|

|Esc|(filtering) cancel filter, (filter applied) remove filter|

#### Document page

keybindings for document pages 

|Key|Description|

|-|-|

|j|page down one line|

|k|page up one line|

|f|page down|

|b|page up|

|d|half page down|

|u|half page up|

|Tab|select link|

|x|open selecting link|

specific to the credits page

|Key|Description|

|-|-|

|t|toggle credits list|

## License

MIT