Project

dsh

0.0
No commit activity in last 3 years
No release in over 3 years
A command line search interface to programming language documentation in the Dash application (Mac OSX) with optional docset keyword filters.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
~> 1.3
>= 0
~> 0.9.2

Runtime

~> 1.3.1
 Project Readme

dsh Gem Version

A command line search interface to programming language/framework documentation in the Dash application (Mac OSX) with optional docset keyword filters.

Installation

Install the Ruby gem with the following command:

$ gem install dsh

You can use the same command to upgrade to a new release.

Usage

To search across all language docsets, simply enter your search query after the dsh command:

dsh <search_term(s)>

To restrict your search to a specific programming language/framework docset, use the -l flag with a docset keyword as the argument:

dsh -l <language> <query>

You can find the language docset keyword in Preferences > Docsets:

Dash Docset Keywords

Enter the keyword that is displayed in your preferences without the colon symbol (:).

Examples

Search across all Dash docsets:

dsh string

Restrict search to documentation for a specific language:

dsh -l python3 print

Use a multiple word search:

dsh -l manpages 'git diff'

License

MIT License

Changelog

v0.2.3 - minor fixes to exception handling

v0.2.2 - removed repository image (was being pushed with the gem unintentionally...)

v0.2.1 - added support for multiple word queries

v0.2.0 - exception handling for incorrect CL switches/flags/arguments

v0.1.1 - documentation update and CL flag changes

v0.1.0 - initial release

✪ Chris