Apiary CLI Client
Apiary CLI client, apiary
.
Description
The Apiary CLI Client gem is a command line tool for developing and previewing API Blueprint documents locally. It can also be used for pushing updated documents to and fetching existing documents from Apiary.
Please see the apiary help
command and the full documentation for an in-depth look in how to use this tool.
For instructions on making your own changes, see Hacking Apiary CLI Client, below.
Installation
Install as a Ruby gem
gem install apiaryio
Using Docker - alternative if you don't install ruby or installation not work for you
Download image:
docker pull apiaryio/client
Run instead apiary
just docker run apiaryio/client
Build from source code:
docker build -t "apiaryio/client" .
Setup Apiary credentials
Required only for publish and fetch commands.
- Make sure you are a registered user of Apiary.
- Retrieve API key (token) on this page.
- Export it as an environment variable:
export APIARY_API_KEY=<your_token>
Command-line Usage
$ apiary help
Commands:
apiary fetch --api-name=API_NAME # Fetch API Description Document from API_NAME.apiary.io
apiary help [COMMAND] # Describe available commands or one specific command
apiary preview # Show API documentation in browser or write it to file
apiary publish --api-name=API_NAME # Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)
apiary version # Show version
Details
fetch
$ apiary help fetch
Usage:
apiary fetch --api-name=API_NAME
Options:
--api-name=API_NAME
[--api-host=HOST] # Specify apiary host
[--output=FILE] # Write API Description Document into specified file
Fetch API Description Document from API_NAME.apiary.io
preview
$ apiary help preview
Usage:
apiary preview
Options:
[--browser=BROWSER] # Show API documentation in specified browser (full command is needed - e.g. `--browser='open -a safari'` in case of osx)
[--output=FILE] # Write generated HTML into specified file
[--path=PATH] # Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file
[--api-host=HOST] # Specify apiary host
[--server], [--no-server] # Start standalone web server on port 8080
[--port=PORT] # Set port for --server option
[--host=HOST] # Set host for --server option
Show API documentation in browser or write it to file
publish
$ apiary help publish
Usage:
apiary publish --api-name=API_NAME
Options:
[--message=COMMIT_MESSAGE] # Publish with custom commit message
[--path=PATH] # Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file
[--api-host=HOST] # Specify apiary host
[--push], [--no-push] # Push API Description to the GitHub when API Project is associated with GitHub repository in Apiary
# Default: true
--api-name=API_NAME
Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)
version
$ apiary help version
Usage:
apiary version
Options:
[--{:aliases=>"-v"}={:ALIASES=>"-V"}]
Show version
Hacking Apiary CLI Client
Build
If needed, install bundler:
$ gem install bundler
Clone the repo:
$ git clone [email protected]:apiaryio/apiary-client.git $ cd apiary-client
Install dependencies:
$ bundle install
Test
Inside the apiary-client
repository directory run:
$ bundle exec rake test
$ bundle exec rake features
Release
Use bundle install
to install your changes locally, for manual and ad-hock testing.
Only gem owners gem owner apiaryio
can publish new gem into RubyGems.
$ rake release
License
Copyright 2012-15 (c) Apiary Ltd.
Released under MIT license. See LICENSE file for further details.