Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/maximed/gost

A gist client in go
https://github.com/maximed/gost

gist-client

Last synced: 2 months ago
JSON representation

A gist client in go

Awesome Lists containing this project

README

        

# Gost

*The gist client in go*

Gost is a client for the gist API,
it allows you to create and browse the gists of [https://gist.github.com/](https://gist.github.com/).

# Installation

You can grab a binary for your platform on the
[releases page](https://github.com/MaximeD/gost/releases).

Or else, you can install it from sources:

```
go get github.com/MaximeD/gost
```

# Usage

## Create gists

```
gost
```

You can supply as many files as you want here.

Full example:

```
gost -p -d "rocking the casbah" fun.go love_gist.rb
```

will create a private gist with description "rocking the casbah"
with two files `fun.go` and `love_gist.rb`.
The resulting url will be copy to your clipboard.

### Command line options

#### Private gists

By default, your gists are public.
If you want a private one, just add `-p` to your command.
On first run, `gost` will create a prompt you for your credentials
and store a token in it's configuration file,
so that you will have to do this step only once.

#### Description

To give your gist a description use `-d `.

#### Open result in browser

To have your browser auto open on the url, use the flag `-o`.
(It will rely on `xdg-open`).

## Update gist

To update a gist:

```
gost -u
```

You can supply an optional `-d` flag to update the description of your gist.

```
gost -u -d
```

## List gists

You can list the gist of a user with the following:

```
gost -l
```

## Download a gist

```
gost -g
```

## Delete a gist

Given you have the id of one of your gist and the right to delete it, use `-D` flag:

```
gost -D
```