1 | # skale
|
2 |
|
3 | [![Join the chat at https://gitter.im/skale-me/skale-cli](https://badges.gitter.im/skale-me/skale-cli.svg)](https://gitter.im/skale-me/skale-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
4 | [![Build Status](https://travis-ci.org/skale-me/skale-cli.svg?branch=master)](https://travis-ci.org/skale-me/skale-cli)
|
5 |
|
6 | Create, run and deploy distributed NodeJS applications
|
7 |
|
8 | The skale command is the quickest and easiest way to create distributed
|
9 | scalable applications based on
|
10 | [skale-engine](https://www.npmjs.com/package/skale-engine) and then
|
11 | to submit them either locally or on the cloud.
|
12 |
|
13 | ## Install
|
14 |
|
15 | Assuming you have already installed [NodeJS](https://nodejs.org):
|
16 |
|
17 | $ npm install -g skale
|
18 |
|
19 | ## Getting started
|
20 |
|
21 | To create an application called `my_app`, simply run
|
22 |
|
23 | $ skale create my_app
|
24 |
|
25 | It will create a directory `my_app`, populate it with a template application
|
26 | `my_app.js`, and install skale-engine dependency using [`npm`](https://npmjs.com).
|
27 |
|
28 | You can then go to `my_app` and run your app using `skale run`:
|
29 |
|
30 | $ cd my_app
|
31 | $ skale run
|
32 |
|
33 | To do something useful, modify your application by editing `my_app.js`,
|
34 | then run again using `skale run`.
|
35 |
|
36 | Under the hood, the `skale run` commands starts a skale-engine cluster on the
|
37 | the localhost at the first invocation, then simply executes `my_app.js`. You
|
38 | can check the status of the cluster using the `skale status` command, and stop
|
39 | it using `skale stop`.
|
40 |
|
41 | To go on further details, please refer to skale-engine documentation.
|
42 |
|
43 | ## Deploying an application
|
44 |
|
45 | *Coming soon*
|
46 |
|
47 | ## Usage
|
48 | ```
|
49 | Usage: skale [options] <command> [<args>]
|
50 |
|
51 | Create, run, deploy clustered node applications
|
52 |
|
53 | Commands:
|
54 | create <app> Create a new application
|
55 | run [<args>...] Run application
|
56 | deploy [<args>...] Deploy application (coming soon)
|
57 | status print status of local skale cluster
|
58 | stop Stop local skale cluster
|
59 |
|
60 | Options:
|
61 | -h, --help Show help
|
62 | -V, --version Show version
|
63 | ```
|
64 |
|
65 | ## License
|
66 |
|
67 | [Apache-2.0](LICENSE)
|