Fetching contributors…
Cannot retrieve contributors at this time
126 lines (72 sloc) 5.39 KB


Flawless command line deployment of Node.js apps to the cloud


Jitsu is a Command Line Tool (CLI) for deploying Node.js applications to the cloud. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line or don't have terminal access you can still do everything Jitsu can do through our web admin, Samurai.

Jitsu requires npm, the node package manager.

One-Line Installation

[sudo] npm install jitsu -g


jitsu is built on some amazing technologies which we've been actively building with the community since 2009. jitsu is fully extend-able and extremely modular ( see Libaries section ).

  • Allows for seamless deployment of your Node.js applications to the cloud
  • Fully supports npm dependency resolution on deployment to Nodejitsu
  • Full support of Nodejitu's API ( a plethora of node.js goodies )
  • Integrated multi-level multi-transport logging support via Winston
  • Too many to list... seek further knowledge or just try it out!

One-Line Deployment

( inside the path of your Node.js application )

 jitsu deploy

This will create a new application, package.json, and deploy your path to Nodejitsu. If it's your first deployment, you'll be prompted for some information such as subdomain and start script but it's really easy and we promise it will only take a few seconds.

If you have any issues deploying your node.js application please feel free to open up an issue on the Github Issues section of this page, we'll have someone get back to you in a flash!


jitsu is mostly self documenting. After installation, run the jitsu command from your command line.

If it's your first time using jitsu, you will be prompted to login with an existing account or create a new account.

After you've logged in, you can start deploying apps immediately!

Command Line Usage

jitsu is mostly self-documenting. Try any of these commands to get started.


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

Common Commands:

Deploys current path to Nodejitsu

 jitsu deploy

Creates a new application on Nodejitsu

 jitsu create

Lists all applications for the current user

 jitsu list

Additional Commands

 jitsu apps
 jitsu snapshots
 jitsu users
 jitsu conf
 jitsu logout


jitsu is mostly self documenting. We suggest just trying it out. All commands will yield friendly messages if you specify incorrect parameters. If you find anything difficult to use, please open up a Github issue or pull request!

 jitsu help
 jitsu help apps
 jitsu help snapshots
 jitsu help users
 jitsu help config

.jitsuconf file

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

jitsu config

If you need to have multiple configuration files, use --localconf or --jitsuconf options.

##jitsu options

jitsu [commands] [options]

--version print jitsu version and exit --localconf search for .jitsuconf file in ./ and then parent directories --jitsuconf [file] specify file to load configuration from --noanalyze skip require-analyzer: do not attempt to dynamicially detect dependencies


jitsu is built on a few well developed, well maintained Node.js libraries. The Nodejitsu team and friends have been building and using these projects actively for the past two years. They are the most used Node libraries (see: and are actively maintained by Nodejitsu and other core members of the Node.js community. Each library serves a specific function and we highly suggest you check each one out individually if you wish to increase your knowledge of Node.js

  • npm - Node Package Manager
  • colors - Terminal Colors module
  • optimist - CLI Options Parsing
  • request - http request module
  • async - Asynchronous Iteration
  • vows - Asynchronous BDD testing library
  • winston - Multi-transport logging library

Need more?

The documentation for jitsu and the Nodejitsu APIs is open-source and a work in-progress. For more information checkout the Nodejitsu Handbook

(C) Copyright 2010, Nodejitsu Inc.