damiensedgwick / op

A super fast way to launch documentation from the command line!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

op

"op" is a small tool that will allow you to open language or framework documentation in your browser from your terminal.

.github/workflows/gorelease.yml

Overview

It is not life changing, but it will help you save a few seconds here and there. Instead of leaving your terminal or ide you can simply type op <language|framework> for a specific set of documentation, or you can type op mdn <term> to open up MDN docs with your query completed.

Demo

From source

If you write or use GoLang on your machine you can quite simply clone this repository

git clone https://github.com/damiensedgwick/op

Change in to the project directory and run go install - You should now be able to open a terminal anywhere you like and run op <language|framework> or op mdn <term>

NB - Make sure you go bin is in your path, if not the above will not work.

Download executable binary from this repo

Latest Releases

!Important for windows

You will have to make sure you do the windows equivalent of the above commands to get it working on your system correctly.

Usage

In your terminal window, simply type either of the following.

op <language|framework> or op mdn <query>

Contributions

If there is a documentation link missing, and you would like to add it, feel free to open up a PR!

About

A super fast way to launch documentation from the command line!


Languages

Language:Go 100.0%