Skip to content
Newer
Older
100644 110 lines (64 sloc) 4.62 KB
641b226 @indexzero [api] Start stubbing out clients and common methods
indexzero authored Feb 21, 2011
1 # jitsu
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
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 Jan 31, 2011
3
d2739f2 @Marak [misc] Updating Readme
Marak authored Apr 12, 2011
4 ## Overview
5
ccaea9f @Marak [misc] Updating ReadMe
Marak authored Apr 12, 2011
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 Apr 12, 2011
7
7d508c8 @Marak [misc] Added npm link in ReadMe.
Marak authored Apr 13, 2011
8 Jitsu requires `npm`, the [node package manager](http://npmjs.org).
d2739f2 @Marak [misc] Updating Readme
Marak authored Apr 12, 2011
9
10
7db22b4 @Marak [misc] Updating ReadMe
Marak authored Apr 12, 2011
11 ## Installation
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored Jan 31, 2011
12
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored Apr 12, 2011
13 [sudo] npm install jitsu
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored Jan 31, 2011
14
7db22b4 @Marak [misc] Updating ReadMe
Marak authored Apr 12, 2011
15 ## Features
16
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
17 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 Apr 12, 2011
18
7db22b4 @Marak [misc] Updating ReadMe
Marak authored Apr 12, 2011
19 - Allows for seamless deployment of your Node.js applications to the cloud
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
20 - Fully supports NPM dependency resolution on deployment to [Nodejitsu](http://nodejitsu.com)
ccaea9f @Marak [misc] Updating ReadMe
Marak authored Apr 12, 2011
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!
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
24
25 # Deploying a path to the cloud
26
27 cd /path/to/myapp
28 jitsu deploy
29
30 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.
31
32 If you have any issues deploying your node.js application please feel free to open up a Github support issues. We'll have someone get back to you in a flash!
33
7db22b4 @Marak [misc] Updating ReadMe
Marak authored Apr 12, 2011
34 ## Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored Feb 2, 2011
35
ccaea9f @Marak [misc] Updating ReadMe
Marak authored Apr 12, 2011
36 Jistsu is mostly self documenting. After installation, run the `jitsu` command from your command line.
37
38 If it's your first time using `jitsu`, you will be prompted to login with an existing account or create a new account.
39
8908f49 @Marak Updating Readme
Marak authored Apr 12, 2011
40 <img src="https://github.com/nodejitsu/jitsu/raw/master/test/promptscreenshot.png"/>
ccaea9f @Marak [misc] Updating ReadMe
Marak authored Apr 12, 2011
41
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored Apr 12, 2011
42 After you've logged in, you can start deploying apps immediately!
43
44 <img src="https://github.com/nodejitsu/jitsu/raw/master/test/screenshot.png"/>
45
ab8d16a @Marak [docs] Cleaning up
Marak authored Feb 2, 2011
46
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
47 ## Command Line Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored Feb 2, 2011
48
992e62a @Marak Updating Readme
Marak authored Apr 12, 2011
49 `jitsu` is mostly self-documenting. Try any of these commands to get started.
50
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
51
52 **Usage:**
53
54 jitsu <resource> <action> <param1> <param2> ...
55
56 **Common Commands:**
57
58 *Deploys current path to [Nodejitsu](http://nodejitsu.com)*
59
60 jitsu deploy
61
62 *Creates a new application on [Nodejitsu](http://nodejitsu.com)*
63
64 jitsu create
65
66 *Lists all applications for the current user*
67
68 jitsu list
69
70 *Additional Commands*
71
72 jitsu apps
73 jitsu snapshots
74 jitsu users
75 jitsu conf
76 jitsu logout
77
78
79
ab8d16a @Marak [docs] Cleaning up
Marak authored Feb 2, 2011
80 ### Help
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored Jan 31, 2011
81
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
82 Jitsu is mostly self documenting. We suggest just trying it out. All commands will yield friendly messages to you if you specify incorrect parameters. If you find anything difficult to use, please open up a Github issue or pull request!
83
e2cdf20 @indexzero [doc] Update README.md
indexzero authored Apr 9, 2011
84 jitsu help
85 jitsu help apps
86 jitsu help snapshots
87 jitsu help users
88 jitsu help config
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. So…
Marak authored Jan 31, 2011
89
7e002ad @Marak [misc] Added .jitsuconf section to Readme
Marak authored Apr 12, 2011
90 ## .jitsuconf file
91
92 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:
93
94 jitsu config
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored Apr 12, 2011
95
96 ## Libraries
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored Apr 12, 2011
97 <a name="Libraries"></a>
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
98 The [Nodejitsu](http://nodejitsu.com) 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 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 Apr 12, 2011
99
f08a670 @Marak Updating ReadMe
Marak authored Apr 12, 2011
100 - [colors](http://github.com/marak/colors) - Terminal Colors module
101 - [optimist](http://github.com/substack/optimist) - CLI Options Parsing
102 - [request](http://github.com/mikeal/request) - http request module
103 - [async](https://github.com/caolan/async) - Asynchronous Iteration
104 - [vows](http://vowsjs.org) - Asynchronous BDD testing library
105 - [winston](http://github.com/indexzero/winston/) - Multi-transport logging library
106
5d9044f @Marak [misc] Added Aliases section in ReadMe
Marak authored Apr 12, 2011
107 ### Need more?
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
108 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 Jan 31, 2011
109
780a590 @Marak [misc] Updating ReadMe
Marak authored Apr 13, 2011
110 #### (C) Copyright 2010, [Nodejitsu](http://nodejitsu.com) Inc.
Something went wrong with that request. Please try again.