This commit is contained in:
tanner0101 2017-06-05 17:01:44 +01:00
parent ca574786ef
commit a021670cbe
3 changed files with 111 additions and 73 deletions

View File

@ -272,6 +272,19 @@
Help
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#framework-commands" title="Framework Commands" class="md-nav__link">
Framework Commands
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -1630,6 +1643,19 @@
Help
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#framework-commands" title="Framework Commands" class="md-nav__link">
Framework Commands
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -1707,6 +1733,13 @@
</pre></div>
<h3 id="framework-commands">Framework Commands<a class="headerlink" href="#framework-commands" title="Permanent link">&para;</a></h3>
<p>The <code>vapor run</code> command is a special toolbox command that forwards to your Vapor application.</p>
<p>You can use <code>vapor run serve</code> to boot your application, or <code>vapor run help</code> to view all available application-level commands. This includes custom commands you may have added to your application.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
</div>
<p>Using <code>vapor run --help</code> will provide information about the <code>run</code> command itself and will not forward to your Vapor application.</p>
<h2 id="updating">Updating<a class="headerlink" href="#updating" title="Permanent link">&para;</a></h2>
<p>The toolbox should be updated by the package manager it was installed with.</p>
<h3 id="homebrew">Homebrew<a class="headerlink" href="#homebrew" title="Permanent link">&para;</a></h3>

View File

@ -192,7 +192,7 @@
},
{
"location": "/getting-started/toolbox/",
"text": "Install Toolbox\n\n\nVapor's command line interface provides shortcuts and assistance for common tasks.\n\n\n\n\n\n\nTip\n\n\nIf you do not want to use the Toolbox or templates, checkout the \nManual\n quickstart.\n\n\n\n\nHelp\n\n\nHelp prints useful information about available commands and flags. You can also run the \n--help\n option on any Toolbox command.\n\n\nvapor --help\n\n\n\n\n\nUpdating\n\n\nThe toolbox should be updated by the package manager it was installed with.\n\n\nHomebrew\n\n\nbrew upgrade vapor\n\n\n\n\n\nAPT\n\n\nsudo apt-get update\nsudo apt-get install vapor\n\n\n\n\n\nTemplates\n\n\nThe toolbox can create a project from the Vapor basic-template or any other git repo.\n\n\nvapor new \nname\n \n[\n--template\n]\n\n\n\n\n\n\n\n\n\n\n\n\nName\n\n\nFlag\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nAPI\n\n\n--template=api\n\n\nJSON API with Fluent database.\n\n\n\n\n\n\nWeb\n\n\n--template=web\n\n\nHTML website with Leaf templates.\n\n\n\n\n\n\n\n\n\n\nNote\n\n\nIf you do not specify a template option, the API template will be used.\nThis may change in the future.\n\n\n\n\nOptions\n\n\nThe toolbox will build an absolute URL based on what you pass as the template option. \n\n\n\n\n--template=web\n clones \nhttp://github.com/vapor/web-template\n\n\n--template=user/repo\n clones \nhttp://github.com/user/repo\n.\n\n\n--template=http://example.com/repo-path\n clones the full url given.\n\n\n--branch=foo\n can be used to specify a branch besides \nmaster\n.",
"text": "Install Toolbox\n\n\nVapor's command line interface provides shortcuts and assistance for common tasks.\n\n\n\n\n\n\nTip\n\n\nIf you do not want to use the Toolbox or templates, checkout the \nManual\n quickstart.\n\n\n\n\nHelp\n\n\nHelp prints useful information about available commands and flags. You can also run the \n--help\n option on any Toolbox command.\n\n\nvapor --help\n\n\n\n\n\nFramework Commands\n\n\nThe \nvapor run\n command is a special toolbox command that forwards to your Vapor application.\n\n\nYou can use \nvapor run serve\n to boot your application, or \nvapor run help\n to view all available application-level commands. This includes custom commands you may have added to your application.\n\n\n\n\nWarning\n\n\n\n\nUsing \nvapor run --help\n will provide information about the \nrun\n command itself and will not forward to your Vapor application.\n\n\nUpdating\n\n\nThe toolbox should be updated by the package manager it was installed with.\n\n\nHomebrew\n\n\nbrew upgrade vapor\n\n\n\n\n\nAPT\n\n\nsudo apt-get update\nsudo apt-get install vapor\n\n\n\n\n\nTemplates\n\n\nThe toolbox can create a project from the Vapor basic-template or any other git repo.\n\n\nvapor new \nname\n \n[\n--template\n]\n\n\n\n\n\n\n\n\n\n\n\n\nName\n\n\nFlag\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nAPI\n\n\n--template=api\n\n\nJSON API with Fluent database.\n\n\n\n\n\n\nWeb\n\n\n--template=web\n\n\nHTML website with Leaf templates.\n\n\n\n\n\n\n\n\n\n\nNote\n\n\nIf you do not specify a template option, the API template will be used.\nThis may change in the future.\n\n\n\n\nOptions\n\n\nThe toolbox will build an absolute URL based on what you pass as the template option. \n\n\n\n\n--template=web\n clones \nhttp://github.com/vapor/web-template\n\n\n--template=user/repo\n clones \nhttp://github.com/user/repo\n.\n\n\n--template=http://example.com/repo-path\n clones the full url given.\n\n\n--branch=foo\n can be used to specify a branch besides \nmaster\n.",
"title": "Toolbox"
},
{
@ -205,6 +205,11 @@
"text": "Help prints useful information about available commands and flags. You can also run the --help option on any Toolbox command. vapor --help",
"title": "Help"
},
{
"location": "/getting-started/toolbox/#framework-commands",
"text": "The vapor run command is a special toolbox command that forwards to your Vapor application. You can use vapor run serve to boot your application, or vapor run help to view all available application-level commands. This includes custom commands you may have added to your application. Warning Using vapor run --help will provide information about the run command itself and will not forward to your Vapor application.",
"title": "Framework Commands"
},
{
"location": "/getting-started/toolbox/#updating",
"text": "The toolbox should be updated by the package manager it was installed with.",

View File

@ -4,7 +4,7 @@
<url>
<loc>/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -13,37 +13,37 @@
<url>
<loc>/getting-started/install-on-macos/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/getting-started/install-on-ubuntu/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/getting-started/toolbox/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/getting-started/hello-world/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/getting-started/manual/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/getting-started/xcode/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -53,49 +53,49 @@
<url>
<loc>/vapor/folder-structure/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/vapor/droplet/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/vapor/views/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/vapor/controllers/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/vapor/provider/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/vapor/hash/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/vapor/log/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/vapor/commands/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -105,7 +105,7 @@
<url>
<loc>/configs/config/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -115,13 +115,13 @@
<url>
<loc>/json/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/json/overview/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -131,31 +131,31 @@
<url>
<loc>/routing/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/routing/overview/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/routing/parameters/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/routing/group/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/routing/collection/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -165,37 +165,37 @@
<url>
<loc>/fluent/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/fluent/getting-started/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/fluent/model/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/fluent/database/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/fluent/query/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/fluent/relations/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -205,13 +205,13 @@
<url>
<loc>/cache/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/cache/overview/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -221,19 +221,19 @@
<url>
<loc>/mysql/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/mysql/provider/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/mysql/driver/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -243,13 +243,13 @@
<url>
<loc>/redis/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/redis/provider/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -259,37 +259,37 @@
<url>
<loc>/auth/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/auth/provider/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/auth/getting-started/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/auth/helper/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/auth/password/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/auth/persist/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -299,13 +299,13 @@
<url>
<loc>/sessions/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/sessions/sessions/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -315,61 +315,61 @@
<url>
<loc>/http/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/request/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/response/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/middleware/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/body/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/response-representable/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/responder/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/client/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/server/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/http/cors/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -379,19 +379,19 @@
<url>
<loc>/leaf/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/leaf/provider/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/leaf/leaf/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -401,13 +401,13 @@
<url>
<loc>/validation/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/validation/overview/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -417,13 +417,13 @@
<url>
<loc>/node/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/node/getting-started/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -433,13 +433,13 @@
<url>
<loc>/core/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/core/overview/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -449,13 +449,13 @@
<url>
<loc>/bits/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/bits/overview/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -465,13 +465,13 @@
<url>
<loc>/debugging/package/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/debugging/overview/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -481,13 +481,13 @@
<url>
<loc>/deploy/nginx/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/deploy/supervisor/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
@ -497,19 +497,19 @@
<url>
<loc>/version/1_5/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/version/2_0/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/version/support/</loc>
<lastmod>2017-06-02</lastmod>
<lastmod>2017-06-05</lastmod>
<changefreq>daily</changefreq>
</url>