edit

Install Toolbox

Vapor's command line interface provides shortcuts and assistance for common tasks.

Vapor Toolbox

Tip

If you do not want to use the Toolbox or templates, checkout the Manual quickstart.

Help

Help prints useful information about available commands and flags. You can also run the --help option on any Toolbox command.

vapor --help

Updating

The toolbox should be updated by the package manager it was installed with.

Homebrew

brew upgrade vapor

APT

apt-get update
apt-get install vapor

Templates

The toolbox can create a project from the Vapor basic-template or any other git repo.

vapor new <name> [--template=<repo-url-or-github-path>]

Warning

Use vapor new --template=api --branch=beta while Vapor 2 is in beta

Options

The toolbox will build an absolute URL based on what you pass as the template option.

  • --template=light clones http://github.com/vapor/light-template.
  • --template=user/repo clones http://github.com/user/repo.
  • --template=http://example.com/repo-path clones the full url given.

Note

If you do not specify a template option, the project will be built from Vapor's basic template.