UNPKG

creepin

Version:

Open user profiles and store favorites

github.com/abrelsfo/creepin

abrelsfo/creepin

115 lines (79 loc) • 3.05 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
[![npm version](https://img.shields.io/npm/v/creepin.svg)](https://www.npmjs.com/package/creepin) [![npm download count](http://img.shields.io/npm/dm/creepin.svg?style=flat)](http://npmjs.org/creepin) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) > Creepin lets you open people profiles quickly and easily. It also lets you store your favorites for later with a handle of your choosing. This can also be used for quick access to your favorite websites all from the command line. <br> ## Install ``` $ npm install --save creepin ``` ## Usage ``` Usage $ creepin([input], [flags]) creepin takes two arrays as arguments, input and flags $ creepin(['abrelsfo'], ['g', 'n']) opens user profile for abrelsfo on Github and npm Note: You don't need the '-' when you aren't using the CLI ``` <br> ## API ### creepin [input] [flags] If one of your arguments has a space then put it in "quotes" ##### input (optional) Input takes two arguments at most. * Zero arguments and zero flags will just list the stored profiles. * One argument will be interpreted as the profile or url that you want to open. * Two arguments are only needed if you plan on saving them for later. ##### flags (optional) -g --> Github<br> -n --> npm<br> -u --> any url<br> -s --> save profile for future use<br> -l --> can be used as only argument, lists the stored profiles<br> -r --> removes stored profile from list<br> -h --> help<br> If you provide nothing then default is: -l<br> If you provide a handle then default is: -g<br> If you provide a handle only and it is a favorite then it will default to: -u <br> ## CLI ``` $ npm install --global creepin ``` ``` Usage $ creepin [input] [flags] Explanation If you give two arguments in the input then the first one is evaluated as the handle for the second argument. The only time you really need two arguments is when you are saving a favorite for later. Flags -g --> Github -n --> npm -u --> any url -s --> save profile for future use -l --> used as only only argument, lists the stored profiles -r --> removes stored profile from list -h --> help If you provide nothing then default is: -l If you provide a handle then default is: -g If you provide a handle only and it is a favorite then it will default to: -u Examples $ creepin "stackoverflow" "http://stackoverflow.com/users/5012922/sirparselot" -s Stored stackoverflow for later stackoverflow is the handle and the url is the profile $ creepin "abrelsfo" -g -n opens profile on github and npm $ creepin "http://stackoverflow.com/users/5012922/sirparselot" -u opens link $ creepin -l abrelsfo: abrelsfo dawsonbotsford: dawsonbotsford stackoverflow: http://stackoverflow.com/users/5012922/sirparselot $ creepin 'stackoverflow' -r Removed stackoverflow $ creepin abrelsfo: abrelsfo dawsonbotsford: dawsonbotsford ``` ## License MIT © [Alex Brelsford](abrelsfo.github.io)