Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

file 169 lines (128 sloc) 4.707 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
  File: README
  
    &mdash; Documentation by YARD 0.8.7.4
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '';
  framesUrl = "frames.html#!file.README.html";
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div id="header">
      <div id="menu">
  
    <a href="_index.html">Index</a> &raquo;
    <span class="title">File: README</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><div id='filecontents'>
<h1 id="label-apiaryio">apiaryio</h1>

<p>Apiary.io CLI</p>

<p><a
href="https://travis-ci.org/apiaryio/apiary-client.png?branch=master">{Build
Status</a>]</p>

<h2 id="label-Install">Install</h2>

<p><strong>install gem</strong> (required)
&lt;code&gt;bash
gem install
apiaryio
&lt;/code&gt;</p>

<p><strong>setup APIARY.io credentials</strong> (required for publish and
fetch command only)</p>
<ol><li>
<p>Retrieve APIKEY on <code>https://login.apiary.io/tokens</code></p>
</li><li>
<p>Save it to your environment variables :</p>
</li></ol>

<pre class="code ruby"><code class="ruby">export APIARY_API_KEY=&lt;your_token_retrieved_on_step_1&gt;</code></pre>

<h2 id="label-Description">Description</h2>

<p>Apiaryio gem provides a way to display your API documentation on your
local
machine, either using static files or using a standalone web
server...</p>

<h2 id="label-Usage">Usage</h2>

<pre class="code ruby"><code class="ruby">$ apiary help

Usage: apiary command [options]
Try &#39;apiary help&#39; for more information.

Currently available apiary commands are:

  preview Show API documentation in default browser
  preview --browser [chrome|safari|firefox] Show API documentation in specified browser
  preview --output [FILE] Write generated HTML into specified file
  preview --path [PATH] Specify path to blueprint file
  preview --api_host [HOST] Specify apiary host
  preview --server Start standalone web server on port 8080
  preview --server --port [PORT] Start standalone web server on specified port
  publish --api-name [API_NAME] Publish apiary.apib on docs.API_NAME.apiary.io
  publish --api-name [API_NAME] \
          --message [COMMIT_MESSAGE] Publish with custom commit message
  fetch --api-name [API_NAME] Fetch apiary.apib from API_NAME.apiary.io

  help Show this help
  version Show version</code></pre>

<h2 id="label-Copyright">Copyright</h2>

<p>Copyright 2012-14 © Apiary Ltd.</p>

<h2 id="label-Contributors">Contributors</h2>
<ul><li>
<p>Jakub Nešetřil</p>
</li><li>
<p>James Charles Russell [botanicus]</p>
</li><li>
<p>Lukáš Linhart [Almad]</p>
</li><li>
<p>Emili Parreño</p>
</li><li>
<p>Peter Grilli [Tu1ly]</p>
</li><li>
<p>Ladislav Prskavec</p>
</li><li>
<p>Honza Javorek</p>
</li><li>
<p>Matthew Rudy Jacobs</p>
</li><li>
<p>Adam Kliment</p>
</li><li>
<p>Jack Repenning</p>
</li><li>
<p>Peter Strapp</p>
</li><li>
<p>Pierre Merlin</p>
</li><li>
<p>František Hába</p>
</li><li>
<p>Benjamin Arthur Lupton</p>
</li></ul>

<h2 id="label-License">License</h2>

<p>Released under MIT license. See LICENSE file for further details.</p>
</div></div>

    <div id="footer">
  Generated on Mon May 12 13:32:43 2014 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.7.4 (ruby-2.0.0).
</div>

  </body>
</html>
Something went wrong with that request. Please try again.