Sha256: 672f2b340850d58cb0f238961007b634a9cb4f01914f8e9ffa22c04c58b6c13e

Contents?: true

Size: 1.62 KB

Versions: 12

Compression:

Stored size: 1.62 KB

Contents

# Dev Center CLI

CLI to interact with Heroku's Dev Center

## Installation

    $ gem install devcenter

## Usage

### Open a published article

    $ devcenter open error-pages

### Save a local copy of an article

You can pull an article from its slug

    $ devcenter pull article-slug

or from its URL:

    $ devcenter pull https://devcenter.heroku.com/articles/article-slug

This will save an `article-slug.md` text file in your local directory. The file includes some metadata (article title and id) followed by the article content in markdown format. You can edit both the title and the content, but **never overwrite the article id**.

### Preview a local copy of an article

    $ devcenter preview dynos

This will open a preview in your default browser and get it refreshed when you save the file. You can specify `--port` and `--host` options to customize the preview web server.

### Update an article in Dev Center from a local file

    $ devcenter push dynos

This will save the title and content from your local article in Dev Center, using your Heroku credentials from `~/.netrc`, which you can set by doing `heroku auth:login`.

### Help

Get available commands

    $ devcenter help

Get help about a specific command

    $ devcenter help pull

### Development

If you have a Dev Center instance, you can point your CLI to it by setting the `DEVCENTER_BASE_URL` env. var (e.g: `export DEVCENTER_BASE_URL=http://localhost:3000`).

## License

See LICENSE.txt file.

The `preview` command uses the [Font Awesome](http://fontawesome.io/) vector icons, which have their own [License](https://github.com/FortAwesome/Font-Awesome#license).

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
devcenter-1.3.0 README.md
devcenter-1.2.0 README.md
devcenter-1.1.9 README.md
devcenter-1.1.8 README.md
devcenter-1.1.6 README.md
devcenter-1.1.5 README.md
devcenter-1.1.4 README.md
devcenter-1.1.3 README.md
devcenter-1.1.2 README.md
devcenter-1.1.1 README.md
devcenter-1.1.0 README.md
devcenter-1.1.0rc2 README.md