Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 82 lines (59 sloc) 2.722 kb
b683077 @Almad Revert rename
Almad authored
1 apiaryio
2 =============
14f1921 @eparreno First commit
eparreno authored
3
56636ad @honzajavorek Removed redundant quotes.
honzajavorek authored
4 Apiary.io CLI
c4b7501 @netmilk Travis badge and @netmilk to notifications, bumped version
netmilk authored
5
213fd93 @abtris Add appveyor config
abtris authored
6 [![Build Status](https://travis-ci.org/apiaryio/apiary-client.png?branch=master)](https://travis-ci.org/apiaryio/apiary-client) [![Build status](https://ci.appveyor.com/api/projects/status/0hmkivbnhf9p3f8d/branch/master?svg=true)](https://ci.appveyor.com/project/Apiary/apiary-client/branch/master)
14f1921 @eparreno First commit
eparreno authored
7
89dcf5c @balupton Added installation instructions to prevent people from installing the…
balupton authored
8
9 ## Install
10
f6118c9 @pimpin Add setup Apiary.io credentials to readme.
pimpin authored
11 **install gem** (required)
89dcf5c @balupton Added installation instructions to prevent people from installing the…
balupton authored
12 ``` bash
b683077 @Almad Revert rename
Almad authored
13 gem install apiaryio
89dcf5c @balupton Added installation instructions to prevent people from installing the…
balupton authored
14 ```
15
f6118c9 @pimpin Add setup Apiary.io credentials to readme.
pimpin authored
16 **setup APIARY.io credentials** (required for publish and fetch command only)
17
18 1. Retrieve APIKEY on `https://login.apiary.io/tokens`
19 2. Save it to your environment variables :
20
21 ```bash
22 export APIARY_API_KEY=<your_token_retrieved_on_step_1>
23 ```
89dcf5c @balupton Added installation instructions to prevent people from installing the…
balupton authored
24
14f1921 @eparreno First commit
eparreno authored
25 ## Description
26
a7789cd @smizell Add link to Apiary CLI client documentation in README
smizell authored
27 The Apiary CLI gem is a command line tool for developing and previewing
28 API Blueprint documents locally. It can also be used for pushing
29 updated documents to and fetching existing documents from Apiary.io.
30
31 Please see the [full documentation](http://client.apiary.io) for an in-depth
32 look in how to use this tool.
14f1921 @eparreno First commit
eparreno authored
33
34 ## Usage
35
36 $ apiary help
37
38 Usage: apiary command [options]
6e32d5d @eparreno Modularize
eparreno authored
39 Try 'apiary help' for more information.
40
41 Currently available apiary commands are:
42
43 preview Show API documentation in default browser
44 preview --browser [chrome|safari|firefox] Show API documentation in specified browser
8d5cad7 @honzajavorek Added --output option to README.
honzajavorek authored
45 preview --output [FILE] Write generated HTML into specified file
6e32d5d @eparreno Modularize
eparreno authored
46 preview --path [PATH] Specify path to blueprint file
47 preview --api_host [HOST] Specify apiary host
48 preview --server Start standalone web server on port 8080
49 preview --server --port [PORT] Start standalone web server on specified port
56636ad @honzajavorek Removed redundant quotes.
honzajavorek authored
50 publish --api-name [API_NAME] Publish apiary.apib on docs.API_NAME.apiary.io
1a3e9fb @honzajavorek Updated usage and contributors in README. Fixes #36.
honzajavorek authored
51 publish --api-name [API_NAME] \
52 --message [COMMIT_MESSAGE] Publish with custom commit message
53 fetch --api-name [API_NAME] Fetch apiary.apib from API_NAME.apiary.io
35c7d4f @abtris Update help for fetch command
abtris authored
54 --output [FILE] Write apiary.apib into specified file
1a3e9fb @honzajavorek Updated usage and contributors in README. Fixes #36.
honzajavorek authored
55 help Show this help
6e32d5d @eparreno Modularize
eparreno authored
56 version Show version
14f1921 @eparreno First commit
eparreno authored
57
58 ## Copyright
59
5d281e7 @abtris Prepare release 0.2.5
abtris authored
60 Copyright 2012-15 (c) Apiary Ltd.
de0c09b @eparreno Fix credits in readme and gemspec files
eparreno authored
61
62 ## Contributors
63
64 - Jakub Nešetřil
1a3e9fb @honzajavorek Updated usage and contributors in README. Fixes #36.
honzajavorek authored
65 - James Charles Russell [botanicus]
66 - Lukáš Linhart [Almad]
de0c09b @eparreno Fix credits in readme and gemspec files
eparreno authored
67 - Emili Parreño
a8d1d4b @tu1ly okapi testing tool
tu1ly authored
68 - Peter Grilli [Tu1ly]
141046d @abtris Add fetch command
abtris authored
69 - Ladislav Prskavec
1a3e9fb @honzajavorek Updated usage and contributors in README. Fixes #36.
honzajavorek authored
70 - Honza Javorek
71 - Matthew Rudy Jacobs
72 - Adam Kliment
73 - Jack Repenning
74 - Peter Strapp
75 - Pierre Merlin
76 - František Hába
77 - Benjamin Arthur Lupton
14f1921 @eparreno First commit
eparreno authored
78
79 ## License
80
81 Released under MIT license. See LICENSE file for further details.
Something went wrong with that request. Please try again.