Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 115 lines (65 sloc) 5.073 kb
641b226 @indexzero [api] Start stubbing out clients and common methods
indexzero authored
1 # jitsu
780a590 @Marak [misc] Updating ReadMe
Marak authored
2 *Flawless command line deployment of Node.js apps to the cloud*
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
3
2614d97 @Marak [ux] Reduced color usage. Added assets folder. Moved / updated Screen…
Marak authored
4 <img src="https://github.com/nodejitsu/jitsu/raw/master/assets/jitsu.png"/>
0974136 @Marak [misc] Added new screenshot
Marak authored
5
d2739f2 @Marak [misc] Updating Readme
Marak authored
6 ## Overview
7
b87d33c @Marak [docs] Updating ReadMe
Marak authored
8 [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://develop.nodejitsu.com/).
d2739f2 @Marak [misc] Updating Readme
Marak authored
9
7d508c8 @Marak [misc] Added npm link in ReadMe.
Marak authored
10 Jitsu requires `npm`, the [node package manager](http://npmjs.org).
d2739f2 @Marak [misc] Updating Readme
Marak authored
11
12
915b0b7 @Marak [misc] Updating ReadMe
Marak authored
13 ## One-Line Installation
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
14
69835cd @Marak [docs] Updated ReadMe
Marak authored
15 [sudo] npm install jitsu -g
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
16
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
17 ## Features
18
a8b187b @Marak [misc] Updating Readme
Marak authored
19 `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](#Libraries) section ).
d2739f2 @Marak [misc] Updating Readme
Marak authored
20
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
21 - Allows for seamless deployment of your Node.js applications to the cloud
915b0b7 @Marak [misc] Updating ReadMe
Marak authored
22 - Fully supports `npm` dependency resolution on deployment to [Nodejitsu](http://nodejitsu.com)
23 - Full support of Nodejitu's API ( a plethora of node.js goodies )
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
24 - Integrated multi-level multi-transport logging support via [Winston](http://github.com/indexzero/winston/)
25 - Too many to list... seek [further knowledge ](http://github.com/nodejitsu/handbook) or just try it out!
780a590 @Marak [misc] Updating ReadMe
Marak authored
26
b87d33c @Marak [docs] Updating ReadMe
Marak authored
27 # One-Line Deployment
28
29 *( inside the path of your Node.js application )*
780a590 @Marak [misc] Updating ReadMe
Marak authored
30
31 jitsu deploy
32
b87d33c @Marak [docs] Updating ReadMe
Marak authored
33
780a590 @Marak [misc] Updating ReadMe
Marak authored
34 This will create a new application, package.json, and deploy your path to [Nodejitsu](http://nodejitsu.com). 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.
35
b87d33c @Marak [docs] Updating ReadMe
Marak authored
36 If you have any issues deploying your node.js application please feel free to open up an issue on the [Github Issues](https://github.com/nodejitsu/jitsu/issues) section of this page, we'll have someone get back to you in a flash!
780a590 @Marak [misc] Updating ReadMe
Marak authored
37
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
38 ## Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored
39
a8b187b @Marak [misc] Updating Readme
Marak authored
40 `jitsu` is mostly self documenting. After installation, run the `jitsu` command from your command line.
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
41
42 If it's your first time using `jitsu`, you will be prompted to login with an existing account or create a new account.
43
2614d97 @Marak [ux] Reduced color usage. Added assets folder. Moved / updated Screen…
Marak authored
44 <img src="https://github.com/nodejitsu/jitsu/raw/master/assets/login.png"/>
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
45
a8b187b @Marak [misc] Updating Readme
Marak authored
46 ## After you've logged in, you can start deploying apps immediately!
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored
47
48
ab8d16a @Marak [docs] Cleaning up
Marak authored
49
780a590 @Marak [misc] Updating ReadMe
Marak authored
50 ## Command Line Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored
51
992e62a @Marak Updating Readme
Marak authored
52 `jitsu` is mostly self-documenting. Try any of these commands to get started.
53
780a590 @Marak [misc] Updating ReadMe
Marak authored
54
55 **Usage:**
56
57 jitsu <resource> <action> <param1> <param2> ...
58
59 **Common Commands:**
60
61 *Deploys current path to [Nodejitsu](http://nodejitsu.com)*
62
63 jitsu deploy
64
65 *Creates a new application on [Nodejitsu](http://nodejitsu.com)*
66
67 jitsu create
68
69 *Lists all applications for the current user*
70
71 jitsu list
72
73 *Additional Commands*
74
75 jitsu apps
76 jitsu snapshots
77 jitsu users
78 jitsu conf
79 jitsu logout
80
81
82
ab8d16a @Marak [docs] Cleaning up
Marak authored
83 ### Help
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
84
b87d33c @Marak [docs] Updating ReadMe
Marak authored
85 `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](https://github.com/nodejitsu/jitsu/issues) or pull request!
780a590 @Marak [misc] Updating ReadMe
Marak authored
86
e2cdf20 @indexzero [doc] Update README.md
indexzero authored
87 jitsu help
88 jitsu help apps
89 jitsu help snapshots
90 jitsu help users
91 jitsu help config
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored
92
7e002ad @Marak [misc] Added .jitsuconf section to Readme
Marak authored
93 ## .jitsuconf file
94
b87d33c @Marak [docs] Updating ReadMe
Marak authored
95 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:
7e002ad @Marak [misc] Added .jitsuconf section to Readme
Marak authored
96
97 jitsu config
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored
98
b87d33c @Marak [docs] Updating ReadMe
Marak authored
99
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored
100 <a name="Libraries"></a>
b87d33c @Marak [docs] Updating ReadMe
Marak authored
101 ## Libraries
102 `jitsu` is built on a few well developed, well maintained Node.js libraries. The [Nodejitsu](http://nodejitsu.com) team and friends have been building and using these projects 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 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
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored
103
d4d8eae @Marak [ux] Updated deploy usage
Marak authored
104 - [npm](http://npmjs.org) - Node Package Manager
f08a670 @Marak Updating ReadMe
Marak authored
105 - [colors](http://github.com/marak/colors) - Terminal Colors module
106 - [optimist](http://github.com/substack/optimist) - CLI Options Parsing
107 - [request](http://github.com/mikeal/request) - http request module
108 - [async](https://github.com/caolan/async) - Asynchronous Iteration
109 - [vows](http://vowsjs.org) - Asynchronous BDD testing library
110 - [winston](http://github.com/indexzero/winston/) - Multi-transport logging library
111
5d9044f @Marak [misc] Added Aliases section in ReadMe
Marak authored
112 ### Need more?
780a590 @Marak [misc] Updating ReadMe
Marak authored
113 The documentation for `jitsu` and the [Nodejitsu](http://nodejitsu.com) 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. So…
Marak authored
114
780a590 @Marak [misc] Updating ReadMe
Marak authored
115 #### (C) Copyright 2010, [Nodejitsu](http://nodejitsu.com) Inc.
Something went wrong with that request. Please try again.