Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 166 lines (94 sloc) 6.642 kb
6c2ecad @AvianFlu [test] Add .travis.yml and Travis badge to readme.
AvianFlu authored
1 # jitsu [![Build Status](https://secure.travis-ci.org/nodejitsu/jitsu.png)](http://travis-ci.org/nodejitsu/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. Some ...
Marak authored
3
2614d97 @Marak [ux] Reduced color usage. Added assets folder. Moved / updated Screensho...
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
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
8 [Jitsu](https://github.com/nodejitsu/jitsu) is a [Command Line Tool (CLI)](http://en.wikipedia.org/wiki/Command-line_interface) for managing and deploying Node.js applications. It's open-source and easy to use. [We've](https://github.com/nodejitsu) designed `jitsu` to be suitable for command line beginners, but still be powerful and extensible enough for production usage.
d2739f2 @Marak [misc] Updating Readme
Marak authored
9
a23f504 @Marak [docs] Updating ReadMe
Marak authored
10 `jitsu` requires `npm`, the [node package manager](http://npmjs.org).
d2739f2 @Marak [misc] Updating Readme
Marak authored
11
a23f504 @Marak [docs] Updating ReadMe
Marak authored
12 ## One-line npm install
d2739f2 @Marak [misc] Updating Readme
Marak authored
13
a23f504 @Marak [docs] Updating ReadMe
Marak authored
14 [sudo] curl http://npmjs.org/install.sh | sh
15
16
17 ## One-line jitsu install
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
18
69835cd @Marak [docs] Updated ReadMe
Marak authored
19 [sudo] npm install jitsu -g
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
20
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
21 ## Features
22
e4915fe @zemanel Fix typo on README.md
zemanel authored
23 `jitsu` is built on some amazing technologies which we've been actively building with the community since 2009. `jitsu` is fully extendable and extremely modular ( see [Libraries](#Libraries) section ).
d2739f2 @Marak [misc] Updating Readme
Marak authored
24
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
25 - Allows for seamless deployment of your Node.js applications to the cloud
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
26 - Ships with use-full boilerplates and sample applications through [Node Apps](https://github.com/nodeapps) project integration
915b0b7 @Marak [misc] Updating ReadMe
Marak authored
27 - Fully supports `npm` dependency resolution on deployment to [Nodejitsu](http://nodejitsu.com)
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
28 - Full support of [Nodejitu's API](https://github.com/nodejitsu/nodejitsu-api) ( a plethora of node.js goodies )
29 - Integrated multi-level multi-transport logging support via [Winston](https://github.com/flatiron/winston)
30 - Too many to list... seek [further knowledge ](https://github.com/nodejitsu/handbook) or just try it out!
780a590 @Marak [misc] Updating ReadMe
Marak authored
31
a23f504 @Marak [docs] Updating ReadMe
Marak authored
32
33 # One-Line Node App Installation
34
35 *( inside an empty directory )*
36
37 jitsu install
38
39
40 # One-Line Node App Deployment
b87d33c @Marak [docs] Updating ReadMe
Marak authored
41
42 *( inside the path of your Node.js application )*
780a590 @Marak [misc] Updating ReadMe
Marak authored
43
44 jitsu deploy
45
b87d33c @Marak [docs] Updating ReadMe
Marak authored
46
780a590 @Marak [misc] Updating ReadMe
Marak authored
47 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.
48
b87d33c @Marak [docs] Updating ReadMe
Marak authored
49 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
50
7db22b4 @Marak [misc] Updating ReadMe
Marak authored
51 ## Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored
52
a8b187b @Marak [misc] Updating Readme
Marak authored
53 `jitsu` is mostly self documenting. After installation, run the `jitsu` command from your command line.
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
54
55 If it's your first time using `jitsu`, you will be prompted to login with an existing account or create a new account.
56
2614d97 @Marak [ux] Reduced color usage. Added assets folder. Moved / updated Screensho...
Marak authored
57 <img src="https://github.com/nodejitsu/jitsu/raw/master/assets/login.png"/>
ccaea9f @Marak [misc] Updating ReadMe
Marak authored
58
a8b187b @Marak [misc] Updating Readme
Marak authored
59 ## After you've logged in, you can start deploying apps immediately!
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored
60
61
ab8d16a @Marak [docs] Cleaning up
Marak authored
62
780a590 @Marak [misc] Updating ReadMe
Marak authored
63 ## Command Line Usage
ab8d16a @Marak [docs] Cleaning up
Marak authored
64
992e62a @Marak Updating Readme
Marak authored
65 `jitsu` is mostly self-documenting. Try any of these commands to get started.
66
780a590 @Marak [misc] Updating ReadMe
Marak authored
67
68 **Usage:**
69
70 jitsu <resource> <action> <param1> <param2> ...
71
72 **Common Commands:**
0dc265e @nicoreed [docs] added docs for the signup and login commands
nicoreed authored
73
970ee26 @Marak [docs] Updating ReadMe
Marak authored
74 *To install a pre-built application*
75
76 jitsu install
77
0dc265e @nicoreed [docs] added docs for the signup and login commands
nicoreed authored
78 *To sign up for [Nodejitsu](http://nodejitsu.com)*
79
80 jitsu signup
81
82 *To log into [Nodejitsu](http://nodejitsu.com)*
83
84 jitsu login
85
780a590 @Marak [misc] Updating ReadMe
Marak authored
86 *Deploys current path to [Nodejitsu](http://nodejitsu.com)*
87
88 jitsu deploy
89
90 *Creates a new application on [Nodejitsu](http://nodejitsu.com)*
91
92 jitsu create
93
94 *Lists all applications for the current user*
95
96 jitsu list
97
98 *Additional Commands*
99
100 jitsu apps
101 jitsu snapshots
102 jitsu users
04816e5 @nicoreed [docs] added the logs and database commands to README.md
nicoreed authored
103 jitsu logs
104 jitsu databases
780a590 @Marak [misc] Updating ReadMe
Marak authored
105 jitsu conf
106 jitsu logout
107
108
109
ab8d16a @Marak [docs] Cleaning up
Marak authored
110 ### Help
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
111
b87d33c @Marak [docs] Updating ReadMe
Marak authored
112 `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
113
e2cdf20 @indexzero [doc] Update README.md
indexzero authored
114 jitsu help
115 jitsu help apps
116 jitsu help snapshots
117 jitsu help users
04816e5 @nicoreed [docs] added the logs and database commands to README.md
nicoreed authored
118 jitsu help logs
119 jitsu help databases
e2cdf20 @indexzero [doc] Update README.md
indexzero authored
120 jitsu help config
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
121
7e002ad @Marak [misc] Added .jitsuconf section to Readme
Marak authored
122 ## .jitsuconf file
123
b87d33c @Marak [docs] Updating ReadMe
Marak authored
124 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
125
1e4183e @mmalecki [fix docs] Fix indent in code blocks
mmalecki authored
126 jitsu config
cbe727d @dominictarr [doc] add --localconf and --jitsuconf docs to README.md
dominictarr authored
127
128 If you need to have multiple configuration files, use --localconf or --jitsuconf options.
129
130 ##jitsu options
131
1e4183e @mmalecki [fix docs] Fix indent in code blocks
mmalecki authored
132 jitsu [commands] [options]
133
134 --version print jitsu version and exit
135 --localconf search for .jitsuconf file in ./ and then parent directories
136 --jitsuconf [file] specify file to load configuration from
137 --noanalyze skip require-analyzer: do not attempt to dynamicially detect dependencies
f7d3313 @Marak [misc] Adde screenshot of prompt
Marak authored
138
079055a @pksunkara Better documentation for using jitsu behind a proxy, Fix #121
pksunkara authored
139 ##jitsu behind proxy
140
141 If you are behind a proxy and you haven't configured jitsu to use it, `jitsu` will throw an error, `Jitsu requires you to connect to Nodejitsu's stack (api.nodejitsu.com)`.
142 In order to solve this issue, you can configure jitsu to use a proxy by executing the following command.
143
144 jitsu config set proxy http://proxy.domain.com:3128/
145
146 If you need to authenticate yourselves to the proxy, you can try this command.
147
148 jitsu config set proxy http://user:pass@proxy.domain.com:3128/
b87d33c @Marak [docs] Updating ReadMe
Marak authored
149
b4aa28e @Marak [misc] Added links to Libaries section
Marak authored
150 <a name="Libraries"></a>
b87d33c @Marak [docs] Updating ReadMe
Marak authored
151 ## Libraries
152 `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
153
d4d8eae @Marak [ux] Updated deploy usage
Marak authored
154 - [npm](http://npmjs.org) - Node Package Manager
f1edb58 @dipen Corrected libraries links in README.md
dipen authored
155 - [colors](https://github.com/marak/colors.js) - Terminal Colors module
156 - [optimist](https://github.com/substack/node-optimist) - CLI Options Parsing
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
157 - [request](https://github.com/mikeal/request) - http request module
f08a670 @Marak Updating ReadMe
Marak authored
158 - [async](https://github.com/caolan/async) - Asynchronous Iteration
159 - [vows](http://vowsjs.org) - Asynchronous BDD testing library
f1edb58 @dipen Corrected libraries links in README.md
dipen authored
160 - [winston](https://github.com/flatiron/winston) - Multi-transport logging library
f08a670 @Marak Updating ReadMe
Marak authored
161
5d9044f @Marak [misc] Added Aliases section in ReadMe
Marak authored
162 ### Need more?
56d60ff @mmalecki [doc] Fix ALL the links!
mmalecki authored
163 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](https://github.com/nodejitsu/handbook)
419bbe6 @Marak [docs] Spec'd out first round of API and documentation for review. Some ...
Marak authored
164
0dc265e @nicoreed [docs] added docs for the signup and login commands
nicoreed authored
165 #### (C) Copyright 2010, [Nodejitsu](http://nodejitsu.com) Inc.
Something went wrong with that request. Please try again.