Command Line Toolkit

Last updated on January 30, 2015 22:08

The Viaduct Command Line Toolkit allows you to interact with your Viaduct applications from the comfort of your command line. To see what you can do, check out this video.

Installation

Viaduct requires Ruby 2.0 or higher to run and it is installed using the command below. If you haven't got Ruby on your machine, you'll need to install it. There's plenty of documentation.

$ gem install viaduct-toolkit

Logging in

The first thing you'll need to do when you've installed the toolkit is to authenticate. Just enter the command below and we'll take you to our website to authenticate.

$ vdt login

Once you've logged you can get a full list of all your applications by simply running:

$ vdt app:list

Usage

The toolkit offers you the vdt command which has a number of sub-commands allowing to carryout various actions, including:

  • Deploying an application
  • Viewing application information
  • Accessing your application & database consoles
  • Importing and exporting databases
  • Adding SSH keys to your user account
  • Uploading/downloading files from running application processes

For a full list of commands and help text, please see the toolkit itself:

$ vdt help          # Full list of available commands
$ vdt help deploy   # Full details for the given command

Determining applications

The app will automatically try to determine which application based on the remote repositories for the repository of the folder you're in. Alternatively, you can specify the application using the --app switch. For example:

$ vdt app:info --app my-app