Skip to content
This repository
Fetching contributors…

Cannot retrieve contributors at this time

file 92 lines (53 sloc) 3.822 kb

jitsu

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

Overview

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 the npm, the node package manager.

Installation

[sudo] npm install jitsu

Features

Jitsu is build with some amazing technologies we've been actively building with the community since 2009. jitsu is fully extendable 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 node.js goodies )
  • Integrated multi-level multi-transport logging support via Winston
  • Too many to list... seek further knowledge or just try it out!

Usage

Jistsu 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 Options

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

Help

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

Aliases

Jitsu has a built in alias system for creating shortcuts / custom command line commands. Adding new aliases is simple, we've created the following to get you started:

Quickly see current configuration:

jitsu conf

Create a new application on Nodejitsu

jitsu create <app-name>

Deploy application in current path to Nodejitsu

jitsu deploy

List all applications for current user

jitsu list

.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 really advised. You should be able to make all configuration changes via:

jitsu config

Libraries

The Nodejitsu team and friends have been building and using these tools actively for the past two years. They are the most used Node libraries (see: http://search.npmjs.org/) and are actively maintained. Each tool serves a specific function and we highly suggest you check each one out individually if you wish to increase your knowledge of Node.js

  • 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.

Something went wrong with that request. Please try again.