Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 70 lines (43 sloc) 3.345 kb
641b226 @indexzero [api] Start stubbing out clients and common methods
indexzero authored
1 # jitsu
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
2 *Flawless command line deployment of your Node.js apps to the cloud*
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
3
d2739f2 @Marak [misc] Updating Readme
Marak authored
4 ## Overview
5
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
6 [Jitsu](http://github.com/nodejitsu/jitsu) is a [Command Line Tool (CLI)](http://en.wikipedia.org/wiki/Command-line_interface) 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](http://nodejitsu.com).
d2739f2 @Marak [misc] Updating Readme
Marak authored
7
8 Jitsu requires the npm, the node package manager.
9
10
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
11 ## Installation
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
12
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored
13 [sudo] npm install jitsu
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
14
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
15 ## Features
16
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
17 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](#Libraries) section).
d2739f2 @Marak [misc] Updating Readme
Marak authored
18
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
19 - Allows for seamless deployment of your Node.js applications to the cloud
20 - Fully supports NPM dependency resolution on deployment to Nodejitsu
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
21 - Full support of Nodejitu's API ( a plethora node.js goodies )
22 - Integrated multi-level multi-transport logging support via [Winston](http://github.com/indexzero/winston/)
23 - Too many to list... seek [further knowledge ](http://github.com/nodejitsu/handbook) or just try it out!
d2739f2 @Marak [misc] Updating Readme
Marak authored
24
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
25 ## Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored
26
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
27 Jistsu is mostly self documenting. After installation, run the `jitsu` command from your command line.
28
29 If it's your first time using `jitsu`, you will be prompted to login with an existing account or create a new account.
30
8908f49 @Marak Updating Readme
Marak authored
31 <img src="https://github.com/nodejitsu/jitsu/raw/master/test/promptscreenshot.png"/>
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
32
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored
33 After you've logged in, you can start deploying apps immediately!
34
35 <img src="https://github.com/nodejitsu/jitsu/raw/master/test/screenshot.png"/>
36
ab8d16a @Marak [docs] Cleaning up
Marak authored
37
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
38 ## Command Line Options
ab8d16a @Marak [docs] Cleaning up
Marak authored
39
992e62a @Marak Updating Readme
Marak authored
40 `jitsu` is mostly self-documenting. Try any of these commands to get started.
41
ab8d16a @Marak [docs] Cleaning up
Marak authored
42 ### Help
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
43
e2cdf20 @indexzero [doc] Update README.md
indexzero authored
44 jitsu help
45 jitsu help apps
46 jitsu help snapshots
47 jitsu help users
48 jitsu help config
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
49
7e002ad @Marak [misc] Added .jitsuconf section to Readme
Marak authored
50 ## .jitsuconf file
51
52 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:
53
54 jitsu config
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored
55
56 ## Libraries
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored
57 <a name="Libraries"></a>
58 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/](http://search.npmjs.org/)) and are actively maintained. Each tool serves a specific function, which we highly suggest you check each one out individually.
59
f08a670 @Marak Updating ReadMe
Marak authored
60 - [colors](http://github.com/marak/colors) - Terminal Colors module
61 - [optimist](http://github.com/substack/optimist) - CLI Options Parsing
62 - [request](http://github.com/mikeal/request) - http request module
63 - [async](https://github.com/caolan/async) - Asynchronous Iteration
64 - [vows](http://vowsjs.org) - Asynchronous BDD testing library
65 - [winston](http://github.com/indexzero/winston/) - Multi-transport logging library
66
67 ### Additional Resources
e2cdf20 @indexzero [doc] Update README.md
indexzero authored
68 The documentation for `jitsu` and the Nodejitsu APIs is open-source and a work in-progress. For more information checkout the [Nodejitsu Handbook](http://github.com/nodejitsu/handbook)
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
69
e2cdf20 @indexzero [doc] Update README.md
indexzero authored
70 #### (C) Copyright 2010, Nodejitsu Inc.
Something went wrong with that request. Please try again.