dsh 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +28 -13
- data/README.rdoc +12 -3
- data/bin/dsh +1 -1
- data/dsh.gemspec +1 -1
- data/img/docset_keywords.png +0 -0
- data/lib/dsh/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1b04bdae88a6a2acff391bd71f46e9d58a71256d
|
|
4
|
+
data.tar.gz: 4609bd9d654e75068d9715d154c19106f2e47469
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3978a2590494dce7e1c272f292c66dd2ae4a49f5fe543aa462544e30a35d60e49257bd9b8506cb9bf1d6bc40f8024afe203106f2fe019d549498a5ad4fc17eef
|
|
7
|
+
data.tar.gz: 294ee446b40ef94337c715a973789f08eaae92687523de8e241534da9c0846b1183bfba18c64d7cbcd1c175585ddbc5a5a204a6d0bf5ed3e893aaf8c53ee3f7b
|
data/README.md
CHANGED
|
@@ -1,18 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# dsh [](http://badge.fury.io/rb/dsh)
|
|
2
2
|
|
|
3
|
-
A command line search interface to programming language documentation in the Dash application (Mac OSX) with optional docset keyword filters.
|
|
3
|
+
A command line search interface to programming language documentation in the [Dash application (Mac OSX)](http://kapeli.com/dash) with optional docset keyword filters.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
gem 'dsh'
|
|
10
|
-
|
|
11
|
-
And then execute:
|
|
12
|
-
|
|
13
|
-
$ bundle
|
|
14
|
-
|
|
15
|
-
Or install it yourself as:
|
|
7
|
+
Install the Ruby gem with the following command:
|
|
16
8
|
|
|
17
9
|
$ gem install dsh
|
|
18
10
|
|
|
@@ -22,8 +14,31 @@ To search across all language docsets, simply enter your search query after the
|
|
|
22
14
|
|
|
23
15
|
dsh <search_term(s)>
|
|
24
16
|
|
|
25
|
-
To restrict your search to a specific programming language docset, use the `-l` or `--lang` flags with
|
|
17
|
+
To restrict your search to a specific programming language/framework docset, use the `-l` or `--lang` flags with a docset keyword as the argument:
|
|
18
|
+
|
|
19
|
+
dsh -l <language> <query>
|
|
20
|
+
|
|
21
|
+
You can find the language docset keyword in Preferences > Docsets:
|
|
22
|
+
|
|
23
|
+
<img src="https://raw.github.com/chrissimpkins/dsh/master/img/docset_keywords.png" width="598" height="530" alt="Dash Docset Keywords">
|
|
24
|
+
|
|
25
|
+
Enter the keyword that is displayed in your preferences **without** the colon symbol (:).
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
Search across all Dash docsets:
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
dsh string
|
|
33
|
+
```
|
|
26
34
|
|
|
27
|
-
|
|
35
|
+
Restrict search to documentation for a specific language:
|
|
28
36
|
|
|
37
|
+
```
|
|
38
|
+
dsh -l python3 print
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
MIT License
|
|
29
43
|
|
|
44
|
+
✪ Chris
|
data/README.rdoc
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
= dsh - A command line search interface to programming language documentation in the Mac OSX Dash
|
|
1
|
+
= dsh - A command line search interface to programming language documentation in the Mac OSX application, Dash.
|
|
2
2
|
|
|
3
3
|
Author:: Christopher Simpkins
|
|
4
4
|
Copyright:: Copyright (c) 2013 Christopher Simpkins
|
|
@@ -9,11 +9,20 @@ License:: mit, see LICENSE.txt
|
|
|
9
9
|
== Links
|
|
10
10
|
|
|
11
11
|
* {Source on Github}[https://github.com/chrissimpkins/dsh]
|
|
12
|
-
* RDoc[LINK TO RDOC.INFO]
|
|
13
12
|
|
|
14
13
|
== Install
|
|
15
14
|
|
|
15
|
+
Install the gem with the following command:
|
|
16
|
+
|
|
17
|
+
$ gem install dsh
|
|
18
|
+
|
|
16
19
|
== Examples
|
|
17
20
|
|
|
18
|
-
|
|
21
|
+
Search across all Dash docsets:
|
|
22
|
+
|
|
23
|
+
$ dsh string
|
|
24
|
+
|
|
25
|
+
Restrict search to documentation for a specific language:
|
|
26
|
+
|
|
27
|
+
$ dsh -l ruby puts
|
|
19
28
|
|
data/bin/dsh
CHANGED
|
@@ -20,7 +20,7 @@ class App
|
|
|
20
20
|
end
|
|
21
21
|
end
|
|
22
22
|
|
|
23
|
-
description "A command line interface to
|
|
23
|
+
description "A command line search interface to programming language/framework documentation in the Dash application (Mac OSX) with optional docset keyword filters."
|
|
24
24
|
# Docset Language Flag:
|
|
25
25
|
on("-l <language>","Language docset filter")
|
|
26
26
|
# Required argument
|
data/dsh.gemspec
CHANGED
|
@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
|
|
|
8
8
|
spec.version = Dsh::VERSION
|
|
9
9
|
spec.authors = ["Chris Simpkins"]
|
|
10
10
|
spec.email = ["git.simpkins@gmail.com"]
|
|
11
|
-
spec.description = %q{A command line interface to
|
|
11
|
+
spec.description = %q{A command line search interface to programming language documentation in the Dash application (Mac OSX) with optional docset keyword filters.}
|
|
12
12
|
spec.summary = %q{dsh}
|
|
13
13
|
spec.homepage = "http://rubygems.org/gems/dsh"
|
|
14
14
|
spec.license = "MIT"
|
|
Binary file
|
data/lib/dsh/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: dsh
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Chris Simpkins
|
|
@@ -94,7 +94,7 @@ dependencies:
|
|
|
94
94
|
- - ~>
|
|
95
95
|
- !ruby/object:Gem::Version
|
|
96
96
|
version: 1.3.1
|
|
97
|
-
description: A command line interface to
|
|
97
|
+
description: A command line search interface to programming language documentation
|
|
98
98
|
in the Dash application (Mac OSX) with optional docset keyword filters.
|
|
99
99
|
email:
|
|
100
100
|
- git.simpkins@gmail.com
|
|
@@ -114,6 +114,7 @@ files:
|
|
|
114
114
|
- features/dsh.feature
|
|
115
115
|
- features/step_definitions/dsh_steps.rb
|
|
116
116
|
- features/support/env.rb
|
|
117
|
+
- img/docset_keywords.png
|
|
117
118
|
- lib/dsh.rb
|
|
118
119
|
- lib/dsh/version.rb
|
|
119
120
|
- test/tc_something.rb
|