Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
106 lines (74 sloc) 3.53 KB

The Jitsu Client

Jitsu is a Command Line Interface (CLI) for interacting with the Nodejitsu platform. It's open-source and easy to use.

Installation

Jitsu is distrubited using the Node Package Manager (npm). Installing jitsu with npm is a snap:

 [sudo] npm install -g jitsu

This command installs jitsu to your Node path, so that it may be run like any other global shell command.

Usage

Commands for jitsu follow this pattern:

jitsu <resource> <action> <param1> <param2> ...

For example, in jitsu apps deploy, "apps" is the resource and "deploy" is the action.

jitsu deploy (jitsu apps deploy)

jitsu deploy will attempt to deploy the application in the current directory to Nodejitsu. It deploys your application using the following steps:

  1. Creates the application (if necessary)
  2. Creates or validates the package.json
  3. Packages and creates a new snapshot
  4. Stops the application (if neccessary)
  5. Starts the application

jitsu create (jitsu apps create)

jitsu create will create a new application. This entails generating a package.json for your app, for the purposes of deployment.

jitsu list (jitsu apps list)

jitsu list lists your applications, as well as their respective states, subdomains, entry points and latest snapshots.

jitsu help

Jitsu is self-documenting. All commands will yield friendly messages to you if you specify incorrect parameters. Additionally, jitsu help will return useful help messages about any given resource or resource/action pair. for instance:

josh@pidgey:~$ jitsu help apps deploy
info:   Welcome to Nodejitsu
info:   It worked if it ends with Nodejitsu ok
info:   Executing command help apps deploy
help:   
help:   
help:   Deploys an application using the following steps:
help:   
help:     1. Creates the application (if necessary)
help:     2. Creates or validates the package.json
help:     3. Packages and creates a new snapshot
help:     4. Stops the application (if neccessary)
help:     5. Starts the application
help:   
help:   jitsu deploy
help:   jitsu apps deploy
help:   
info:   Nodejitsu ok
josh@pidgey:~$ 

If no resource and/or action are specified, then jitsu help alone will describe what resources are available.

jitsu apps

In addition to the commands aliased to jitsu create, jitsu deploy and jitsu list, the apps resource allows you to create, destroy, stop, start and otherwise interact with your applications.

jitsu config

jitsu config commands allow you to edit your local jitsu confuration file.

jitsu snapshots

jitsu snapshots * commands allow you to work with snapshots for your Applications on Nodejitsu. Snapshots are images of your Application's code that are deployed to the Nodejitsu Platform.

For commands that take a <name> parameter, if no parameter is supplied, jitsu will attempt to read the package.json from the current directory.

jitsu users

jitsu users * commands allow you to work with new or existing Nodejitsu user accounts. You will be prompted for additional user information as required.

.jitsuconf file

All configuration data for your local jitsu install is located in the .jitsuconf file located in your home directory. Directly modifying this file is not advised. You should be able to make all configuration changes using jitsu config.

Jump to Line
Something went wrong with that request. Please try again.