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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
gist-paste(1) -- upload code to https://gist.github.com
=======================================================
## Synopsis
The gist gem provides a `gist-paste` command that you can use from your terminal to
upload content to https://gist.github.com/.
## Installation
If you have ruby installed:
gem install gist
If you're using Bundler:
source :rubygems
gem 'gist'
For OS X, gist lives in Homebrew
brew install gist
## Command
To upload the contents of `a.rb` just:
gist-paste a.rb
Upload multiple files:
gist-paste a b c
gist-paste *.rb
By default it reads from STDIN, and you can set a filename with `-f`.
gist-paste -f test.rb <a.rb
Alternatively, you can just paste from the clipboard:
gist-paste -P
Use `-p` to make the gist private:
gist-paste -p a.rb
Use `-d` to add a description:
gist-paste -d "Random rbx bug" a.rb
You can update existing gists with `-u`:
gist-paste lib/gist.rb bin/gist-paste -u 42f2c239d2eb57299408
If you'd like to copy the resulting URL to your clipboard, use `-c`.
gist-paste -c <a.rb
If you'd like to copy the resulting embeddable URL to your clipboard, use `-e`.
gist-paste -e <a.rb
And you can just ask gist to open a browser window directly with `-o`.
gist-paste -o <a.rb
To list (public gists or all gists for authed user) gists for user
gist-paste -l : all gists for authed user
gist-paste -l defunkt : list defunkt's public gists
See `gist-paste --help` for more detail.
## Login
If you want to associate your gists with your GitHub account, you need to login
with gist-paste. It doesn't store your username and password, it just uses them to get
an OAuth2 token (with the "gist" permission).
gist-paste --login
Obtaining OAuth2 access_token from github.
GitHub username: ConradIrwin
GitHub password:
2-factor auth code:
Success! https://github.com/settings/applications
You can read the 2-factor auth code from an sms or the authentification app,
depending on how you [set your account up](https://github.com/settings/admin).
Note: 2-factor authentication
[just appeared recently](https://github.com/blog/1614-two-factor-authentication),
so if you run into errors, update the gist gem.
gem update gist
This token is stored in `~/.gist` and used for all future gisting. If you need to
you can revoke it from https://github.com/settings/applications, or just delete the
file. If you need to store tokens for both github.com and a Github Enterprise instance
you can save your Github Enterprise token in `~/.gist.github.example.com` where
"github.example.com" is the URL for your Github Enterprise instance.
After you've done this, you can still upload gists anonymously with `-a`.
gist-paste -a a.rb
# Library
You can also use Gist as a library from inside your ruby code:
Gist.gist("Look.at(:my => 'awesome').code")
If you need more advanced features you can also pass:
* `:access_token` to authenticate using OAuth2 (default is `File.read("~/.gist")).
* `:filename` to change the syntax highlighting (default is `a.rb`).
* `:public` if you want your gist to have a guessable url.
* `:description` to add a description to your gist.
* `:update` to update an existing gist (can be a URL or an id).
* `:anonymous` to submit an anonymous gist (default is false).
* `:copy` to copy the resulting URL to the clipboard (default is false).
* `:open` to open the resulting URL in a browser (default is false).
NOTE: The access_token must have the "gist" scope.
If you want to upload multiple files in the same gist, you can:
Gist.multi_gist("a.rb" => "Foo.bar", "a.py" => "Foo.bar")
If you'd rather use gist's builtin access_token, then you can force the user
to obtain one by calling:
Gist.login!
This will take them through the process of obtaining an OAuth2 token, and storing it
in `~/.gist`, where it can later be read by `Gist.gist`
## GitHub enterprise
If you'd like `gist-paste` to use your locally installed [GitHub Enterprise](https://enterprise.github.com/),
you need to export the `GITHUB_URL` environment variable in your `~/.bashrc`.
export GITHUB_URL=http://github.internal.example.com/
Once you've done this and restarted your terminal (or run `source ~/.bashrc`), gist-paste will
automatically use github enterprise instead of the public github.com
## Configuration
If you'd like `-o` or `-c` to be the default when you use the gist-paste executable, add an
alias to your `~/.bashrc` (or equivalent). For example:
alias gist-paste='gist-paste -c'
If you'd prefer gist-paste to open a different browser, then you can export the BROWSER
environment variable:
export BROWSER=google-chrome
If clipboard or browser integration don't work on your platform, please file a bug or
(more ideally) a pull request.
If you need to use an HTTP proxy to access the internet, export the `HTTP_PROXY` or
`http_proxy` environment variable and gist-paste will use it.
## Meta-fu
Thanks to @defunkt and @indirect for writing and maintaining versions 1 through 3.
Thanks to @rking and @ConradIrwin for maintaining version 4.
Licensed under the MIT license. Bug-reports, and pull requests are welcome.
|
