Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Jist just gists
Ruby
tree: 115dfe456e

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
Gemfile
LICENSE.MIT
README.md
Rakefile
gist.gemspec

README.md

Gist is a gem that allows you to publish a gist from Ruby.

Installation

As with all ruby gems, you can install Gist (assuming you have ruby and rubygems) with:

$ gem install gist

If you want to use the library in your application, and you're using Bundler. Add the following to your Gemfile.

source :rubygems
gem 'gist'

Command

The gist gem provides a gist command that you can use from your terminal to upload content to https://gist.github.com/.

It's easy to use. To upload the contents of a.rb just:

$ gist a.rb
https://gist.github.com/0d07bc98c139810a4075

Upload multiple files :

$ gist a b c
$ gist *.rb

By default it reads from STDIN, and you can set a filename with -f.

$ gist -f test.rb <a.rb
https://gist.github.com/7db51bb5f4f35c480fc8

Alternatively, you can just paste from the clipboard:

$ gist -P
https://gist.github.com/6a330a11a0db8e52a6ee

Use -p to make the gist public and -d to add a description.

$ gist -p -d "Random rbx bug" a.rb
https://gist.github.com/2977722

You can update existing gists with -u:

$ gist lib/gist.rb bin/gist -u 42f2c239d2eb57299408
https://gist.github.com/42f2c239d2eb57299408

If you'd like to copy the resulting URL to your clipboard, use -c.

$ gist -c <a.rb
https://gist.github.com/7db51bb5f4f35c480fc8

If you'd like to copy the resulting embeddable URL to your clipboard, use --copy-js.

$ gist --copy-js <a.rb
<script src="https://gist.github.com/7db51bb5f4f35c480fc8"></script>

And you can just ask gist to open a browser window directly with -o.

$ gist -o <a.rb
https://gist.github.com/7db51bb5f4f35c480fc8

See gist --help for more detail.

Login

If you want to associate your gists with your github account, you need to login with gist. It doesn't store your username and password, it just uses them to get an OAuth2 token (with the "gist" permission).

gist --login
Obtaining OAuth2 access_token from github.
Github username: ConradIrwin
Github password:
Success! https://github.com/settings/applications

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.

After you've done this, you can still upload gists anonymously with -a.

gist -a a.rb
https://gist.github.com/6bf7ec379fc9119b1f15

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 to use your locally installed Github Enterprise, 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 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 executable, add an alias to your ~/.bashrc (or equivalent). For example:

alias gist='gist -c'

If you'd prefer gist 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 will use it.

Meta-fu

I wrote this because the gist gem is out of action, and has been for many months.

It's licensed under the MIT license, and bug-reports, and pull requests are welcome.

Something went wrong with that request. Please try again.