HTML output: Template Param: "+req.params.tparam+
612 | " Flag: " + flag +"
");
613 | },
614 | {
615 | id: 'sample_html',
616 | name: 'html',
617 | usage: 'html tparam qparam',
618 | example: 'html tparam qparam',
619 | doc: 'sample for a POST command getting a template param returning html',
620 | params: {
621 | "bparam" : {
622 | "short": "b",
623 | "type": "string",
624 | "doc": "template param",
625 | "style": "body",
626 | "required": "true"
627 | },
628 | "flag" : {
629 | "short": "f",
630 | "type": "bool",
631 | "doc": "some boolean flag",
632 | "style": "query",
633 | "required": "true"
634 | },
635 |
636 | }
637 | }
638 | );
639 |
640 | * The following command: `someplugin html 1 -f` calls `POST /api/someplugin/html?flag=true` with a body `{bparam: 1}` and returns the result `HTML output: Template Param: 1 Flag: true
`.
641 | * The following command: `someplugin html 1` calls `/api/someplugin/html` with a body `{bparam: 1}` and returns the following result `HTML output: Template Param: 1 Flag: undefined
`.
642 |
643 |
644 | ### Advanced Commands
645 |
646 | Commands that need any processing on the client side, are considered as advanced commands.
647 | Such commands may be for example, commands that get `json` and present charts, or any other command that gets the results and make some further processing before displaying it to the user.
648 |
649 | Advanced command will define a `controller` attribute, in which a javascript file and a handler method name will be set.
650 | The following `sample handler` command, will get two parameters, and the returned result will be transfered to the `handler` method in the `/plugins/someplugin.js` file.
651 | The `controller.handler` attribute is optional and will override the default handler name which is the command name if defined.
652 |
653 |
654 | app.get('/handler/:tparam', function(req, res) {
655 | var tparam = req.params.tparam;
656 | var qparam = req.query['qparam'];
657 |
658 | var o = {tparam: tparam};
659 | res.writeHead(200, {'Content-Type': 'application/json' });
660 | res.end(JSON.stringify(o));
661 | },
662 | {
663 | id: 'sample_handler',
664 | name: 'handler',
665 | usage: 'handler',
666 | example: 'handler',
667 | doc: 'sample for a GET command using external handler',
668 | params: {
669 | "tparam" : {
670 | "short": "t",
671 | "type": "string",
672 | "doc": "template param",
673 | "style": "template",
674 | "required": "true"
675 | }
676 | },
677 | controller: {
678 | url: '../../plugins/someplugin.js',
679 | handler: 'handler' // this is optional, the default will be the command name
680 | }
681 | }
682 | );
683 |
684 | The following is the `/plugins/someplugin.js` file.
685 |
686 | console.info('sample handler loaded');
687 |
688 | this.handler = function(error, response){
689 | if ($.query.get('debug')) debugger;
690 | var args = response.args;
691 | var context = response.context;
692 | var url = context.url;
693 | var env = context.env;
694 | var command = context.command;
695 | var data = response.data;
696 |
697 | var progress = 0;
698 | var intrvl = setInterval(function(){
699 | response.promise.setProgress(progress);
700 | if(progress==100) {
701 | clearInterval(intrvl);
702 | response.promise.resolve(
703 | $("").addClass('anode-sample').html(
704 | 'this is the client side plugin handler speaking.. got the following parametrs:' + JSON.stringify(args) +
705 | '. got the following response: ' + JSON.stringify(data)));
706 | }
707 | progress+=10;
708 | }, 200);
709 | }
710 |
711 | When the script is loaded, it is wrapped in a function and called with a `call` method, providing the context object. All handlers will be added to this context when executing the wrapped code.
712 | Since the script is loaded dynamically, you wan't be able to see it in the developer tools of Chrome/FireFox. One solution for this issue, is adding `if ($.query.get('debug')) debugger;`
713 | statement to the begining of the method, and load the console with `?debug` at the query string. This will make the browser to stop at this line and allow you to debug it.
714 | When the script is loaded, it is attached as the command execute method.
715 | When the console calls this method, it will pass an `error` and a `response` object.
716 | The `response` object contains the following parameters:
717 |
718 | * `args`- contains all arguments provided as part of the command line.
719 | * `data`- contains the data returned from the api call.
720 | * `promise`- an object that helps us manage the command response. This object contains the following methods:
721 | * `setProgress(percent)`- set a percentage indicator, use when the processing might be long and we would like to update the user on the progress that is made.
722 | * `resolve(res)`- used to end the command processing by passing the final result to the console. The result may be any string or html element.
723 | * `context`- contains command execution related objects such as
724 | * `url`- the url that was called .
725 | * `env`- a copy of the environment variable collection (so it won't be able to change it).
726 | * `command`- a copy of the command object if there's any need for details from it.
727 |
728 | Try executing `someplugin handler val` to see how it behaves.
729 |
730 | ### Adding A Command Custom Style
731 |
732 | If the controller needs any special stylesheet, on the server side, use the `cssUrl` or the `css` attributes as can be seen in the sample file for the `htmlbcast` and `handler` commands.
733 |
734 | controller: {
735 | css: '.anode-sample-class{ background-color: green; }'
736 | }
737 |
738 | controller: {
739 | url: '../../plugins/someplugin.js',
740 | cssUrl: '../../plugins/someplugin.css'
741 | }
742 |
743 |
744 | __Note:__ It is very important to namespace your css classes to avoid impact on other elements in the DOM. In the example above, the style is namespaced with the `anode-sample` class.
745 |
--------------------------------------------------------------------------------
/docs/env.md:
--------------------------------------------------------------------------------
1 | Environment Variables
2 | =====================
3 | The console maintains environment variables, used to control its behaviour as well as by the different commands.
4 | The following list is the current predefined environment variables, type `set` to see it:
5 |
6 | * `maxResults` used to control the max number of results being displayed.
7 | * `maxHistory` used to control the max number of commands kept in history.
8 | * `jsonViewCollapseLevel` used to control the level of depth after which the result in a json-view control are collapsed automatically.
9 | * `liveIterationsCount` used to control the number of command refreshes when using the `---live` flag.
10 | * `app` defines the application on which we would like to act upon; used by most of the app-related commands as a default value.
11 |
12 | Console's Context
13 | -----------------
14 | The prompt label on the left side of the command line, is the __context__ of the commands invoked.
15 |
16 | For example, a command which defines a required parameter named `app`, will automatically use the value
17 | from the environment variable if available, without the need to provide it as part of the command line.
18 | If the environment variable is not present or contains an empty value, a value will have to be provided
19 | as part of the command line.
20 |
21 | `
22 | There's currently no validations for the environment values.
23 | `
24 |
25 | Adding Environment Variables
26 | ----------------------------
27 | You can create new environment variables by simply typing `set name value`.
28 | Using environment values as part of a command is easy as typing `$varname`, for example `log --top $mytop` will use the `mytop` value from
29 | the environment variable when parsing and executing the command.
30 |
31 | Managing Environment Variables
32 | ------------------------------
33 | Type `set varname -c`, `set varname --clear` or `set varname ''` to clear an environment variable.
34 | Type `set varname -d` or `set varname --delete` to remove an environment variable from the list.
35 | Type `set -r` or `set --restore` to restore the environment variables collection to the original values.
36 |
37 | Persistency
38 | -----------
39 | The environment variables are persistent. Whenever the console is started, the environment variables are initialized with the last state from the
40 | browser's local storage, keeping the context used last time.
41 |
42 |
--------------------------------------------------------------------------------
/docs/extend.md:
--------------------------------------------------------------------------------
1 | Extending The Console
2 | =====================
3 | __Extending the console is easy!__
4 |
5 | The console uses metadata defined by the docRouter module to generate the commands.
6 | In order to create another command, add a new file under the `repo/sys/console/api` folder. The command will be named after the new api file name.
7 |
8 | The api file should expose the following structure:
9 |
10 | module.exports = { console: { autoLoad: true, router: expressRouter } };
11 |
12 | When the `autoLoad` flag is set to `true`, it will make the plugin to be automatically integrated into the console when it is started.
13 | The `router` parameter is the express `router` object. Look at the api files for an example of how the apis are exposed.
14 |
15 | Each API can contain any number of commands, all namespaced by the api file name. The console will generate a command for each of the methods in the api file.
16 | To execute a method (command), type the api file name and then the method name. ie, to execute `command1` in file `api1`, type `api1 command1` and then provide the params if required.
17 |
18 | Adding Simple Commands
19 | ----------------------
20 | Simple commands are commands that get parameters and return json/html to be displayed in the console as a result of executing the command with the provided parameters.
21 | These commands do not require any client side logics. They are called by the console with the neccessary parameters provided, process the request and return the __final__ result which is displayed as is.
22 | A command that returns a `json` result, will use a generic json-view control to display the object, any other result will be displayed as is (`html`).
23 |
24 | Most of the commands currently implemented are _simple_ commands.
25 |
26 | In this manual we will refer to the `sample.js` file as an example to extending the console.
27 |
28 | As can be seen, the file begins with the docRouter definition, defining `/api/sample` as the root for this api:
29 |
30 | docRouter(router, '/api/sample', function (router) {
31 |
32 |
33 | Each method in the api file defines
34 |
35 | * a Verb- `GET` or `POST`- The console uses this info to invoke the method
36 | * a set of parameters- Parameters are optional. Each parameter defines its
37 | * `type`- The parameter type: `string`, `int`, `bool`.
38 | * `required`- `true`/`false`.
39 | * `style`- `template`- this parameter is expected to be provided as part if the url, `query`- as part of the querystring or `body`- as part of the post body.
40 | * `short`- an optional switch that will be used to refer that parameter in the command line.
41 | * `defaultValue`- a value that will be used if the parameter was not provided as part of the command line. In this case, the value is automatically considered as an optional parameter.
42 | * `defaultEnvVar`- defines an environment variable parameter name that will be used as a default value if the parameter was not provided. If it does not exist or empty, the default value will be used if provided as described above.
43 | An example to using this option can be found in the `log.js` api file.
44 |
45 |
46 | Sample 1:
47 | ---------
48 | The following is an example for a command that gets 3 parameters: `tparam1` and `tparam2` which are defined as a `template` parameters, and `qparam` which is defined as a `qurtystring` parameter.
49 | The `tparam2` parameter has a `defaultValue` set, which means that as far of the console's concern, this is an optional parameter that will get the value provided in the `defaultValue` if not provided
50 | in the command line.
51 |
52 | app.get('/json/:tparam1/:tparam2', function(req, res) {
53 | var tparam1 = req.params.tparam1;
54 | var tparam2 = req.params.tparam2;
55 | var qparam = req.query['qparam'];
56 |
57 | var o = {tparam1: tparam1, tparam2: tparam2, qparam: qparam};
58 | res.writeHead(200, {'Content-Type': 'application/json' });
59 | res.end(JSON.stringify(o));
60 | },
61 | {
62 | id: 'sample_json',
63 | name: 'json',
64 | usage: 'json tparam1 qparam [tparam2]',
65 | example: 'json tparam1 qparamValue',
66 | doc: 'sample for a GET command getting template params and a query param',
67 | params: {
68 | "tparam1" : {
69 | "short": "b",
70 | "type": "string",
71 | "doc": "template param",
72 | "style": "template",
73 | "required": "true"
74 | },
75 | "qparam" : {
76 | "short": "q",
77 | "type": "string",
78 | "doc": "querty string param",
79 | "style": "query",
80 | "required": "true"
81 | },
82 | tparam2 : {
83 | "short": "a",
84 | "type": "string",
85 | "doc": "template param",
86 | "style": "template",
87 | "required": "true",
88 | "defaultValue": "someTemplateValue"
89 | }
90 | }
91 | }
92 | );
93 |
94 |
95 | * The following command: `sample json 1 2` calls `GET /api/sample/json/1/someTemplateValue?qparam=2` and returns the result `{"tparam1":"1","tparam2":"someTemplateValue","qparam":"2"}`.
96 | * The following command: `sample json 1 2 3` calls `GET /api/sample/json/1/3?qparam=2` and returns the following result `{"tparam1":"1","tparam2":"3","qparam":"2"}`.
97 |
98 | __Required parameters should always be provided at the begining of the command__
99 |
100 | Sample 2:
101 | ---------
102 | The following `sample html` command defines a required bosy parameter `bparam` and also an optional boolean parameter `flag`.
103 | Boolean parameters are always considered as optional and defaults to `false`. To set them to `true`, we should only add them to the command line.
104 | Notice that this time, the method uses the `POST` verb, and that the `bparam` parameter will be sent as part of the request's body.
105 |
106 | app.post('/html', function(req, res) {
107 | var flag = req.query.flag;
108 | res.writeHead(200, {'Content-Type': 'text/html' });
109 | res.end("
HTML output: Template Param: "+req.params.tparam+
110 | " Flag: " + flag +"
");
111 | },
112 | {
113 | id: 'sample_html',
114 | name: 'html',
115 | usage: 'html tparam qparam',
116 | example: 'html tparam qparam',
117 | doc: 'sample for a POST command getting a template param returning html',
118 | params: {
119 | "bparam" : {
120 | "short": "b",
121 | "type": "string",
122 | "doc": "template param",
123 | "style": "body",
124 | "required": "true"
125 | },
126 | "flag" : {
127 | "short": "f",
128 | "type": "bool",
129 | "doc": "some boolean flag",
130 | "style": "query",
131 | "required": "true"
132 | },
133 |
134 | }
135 | }
136 | );
137 |
138 | * The following command: `sample html 1 -f` calls `POST /api/sample/html?flag=true` with a body `{bparam: 1}` and returns the result `HTML output: Template Param: 1 Flag: true
`.
139 | * The following command: `sample html 1` calls `/api/sample/html` with a body `{bparam: 1}` and returns the following result `HTML output: Template Param: 1 Flag: undefined
`.
140 |
141 | Advanced Commands
142 | =================
143 | Commands that need any processing on the client side, are considered as advanced commands.
144 | Such commands may be for example, commands that get `json` and present charts, or the current log command that gets the results and make some further processing before displaying it to the user.
145 |
146 | Advanced command will define a `controller` attribute, in which a javascript file and a handler method name will be set.
147 | The following `sample handler` command, will get two parameters, and the returned result will be transfered to the `handler` method in the `/plugins/sample.js` file.
148 | The `controller.handler` attribute is optional and will override the default handler name which is the command name if defined.
149 |
150 |
151 | app.get('/handler/:tparam', function(req, res) {
152 | var tparam = req.params.tparam;
153 | var qparam = req.query['qparam'];
154 |
155 | var o = {tparam: tparam};
156 | res.writeHead(200, {'Content-Type': 'application/json' });
157 | res.end(JSON.stringify(o));
158 | },
159 | {
160 | id: 'sample_handler',
161 | name: 'handler',
162 | usage: 'handler',
163 | example: 'handler',
164 | doc: 'sample for a GET command using external handler',
165 | params: {
166 | "tparam" : {
167 | "short": "t",
168 | "type": "string",
169 | "doc": "template param",
170 | "style": "template",
171 | "required": "true"
172 | }
173 | },
174 | controller: {
175 | url: '../../plugins/sample.js',
176 | handler: 'handler' // this is optional, the default will be the command name
177 | }
178 | }
179 | );
180 |
181 | The following is the `/plugins/sample.js` file.
182 | The `anode.loadCss` and `anode.addCss` are discussed later on in the _Adding A Command Custom Style_ section.
183 |
184 | console.info('sample handler loaded');
185 |
186 | // the following 2 lines are possible. in this case, the css are defined on the server side
187 | //anode.loadCss('plugins/sample.css');
188 | //anode.addCss(".anode-sample {width: 300px;border: 1px solid gray;background-color: rgba(236, 255, 117, 0.60);padding: 4px;}")
189 |
190 | // anode will always be in the global context in this stage as this script always loaded after anode is already initialized
191 | this.handler = function(error, response){
192 | if ($.query.get('debug')) debugger;
193 | var args = response.args;
194 | var context = response.context;
195 | var url = context.url;
196 | var env = context.env;
197 | var command = context.command;
198 | var data = response.data;
199 |
200 | var progress = 0;
201 | var intrvl = setInterval(function(){
202 | response.promise.setProgress(progress);
203 | if(progress==100) {
204 | clearInterval(intrvl);
205 | response.promise.resolve(
206 | $("").addClass('anode-sample').html(
207 | 'this is the client side plugin handler speaking.. got the following parametrs:' + JSON.stringify(args) +
208 | '. got the following response: ' + JSON.stringify(data)));
209 | }
210 | progress+=10;
211 | }, 200);
212 | }
213 |
214 | When the script is loaded, it is wrapped in a function and called with a `call` method, providing the context object. All handlers will be added to this context when executing the wrapped code.
215 | Since the script is loaded dynamically, you wan't be able to see it in the developer tools of Chrome/FireFox. One solution for this issue, is adding `if ($.query.get('debug')) debugger;`
216 | statement to the begining of the method, and load the console with `?debug` at the query string. This will make the browser to stop at this line and allow you to debug it.
217 | When the script is loaded, it is attached as the command execute method.
218 | When the console calls this method, it will pass an `error` and a `response` object.
219 | The `response` object contains the following parameters:
220 |
221 |
222 | * `args`- contains all arguments provided as part of the command line.
223 | * `data`- contains the data returned from the api call.
224 | * `promise`- an object that helps us manage the command response. This object contains the following methods:
225 | * `setProgress(percent)`- set a percentage indicator, use when the processing might be long and we would like to update the user on the progress that is made.
226 | * `resolve(res)`- used to end the command processing by passing the final result to the console. The result may be any string or html element.
227 | * `context`- contains command execution related objects such as
228 | * `url`- the url that was called .
229 | * `env`- a copy of the environment variable collection (so it won't be able to change it).
230 | * `command`- a copy of the command object if there's any need for details from it.
231 |
232 | Try executing `sample handler val` to see how it behaves.
233 |
234 | Adding A Command Custom Style
235 | -----------------------------
236 | If the controller needs any special stylesheet, it can do so in few ways
237 |
238 | * Use the `anode.loadCss(url)` command to load a css file and add it to the DOM.
239 | * Use the `anode.addCss(style)` command to embed style classes.
240 | * On the server side, use the `cssUrl` or the `css` attributes as can be seen in the sample file for the `htmlbcast` and `handler` commands.
241 |
242 |
243 | controller: {
244 | css: '.anode-sample-class{ background-color: green; }'
245 | }
246 |
247 | controller: {
248 | url: '../../plugins/sample.js',
249 | cssUrl: '../../plugins/sample.css'
250 | }
251 |
252 |
253 | __Note:__ It is very important to namespace your css classes to avoid impact on other elements in the DOM. In the example above, the style is namespaced with the `anode-sample` class.
254 |
255 |
256 | Adding Remote Management API
257 | ============================
258 | Please type `man plugins` for information about how to create your own remote management API and integrate it into the console.
259 |
260 |
--------------------------------------------------------------------------------
/docs/pinPannel.md:
--------------------------------------------------------------------------------
1 | Managing The Pin Panel
2 | =========================
3 |
4 | _Pin Panel_ is a panel on the right side of the screen, letting you keep command results always visible to you.
5 | Think of Performance monitor charts, long processing test execution commands, placing these manuals always-on and more.
6 |
7 | To make the board visible, execute the `panel` command. Whenever executed, this command will toggle the visibility state of the board.
8 |
9 | There are two ways to pin command results on _Pin Panel':
10 |
11 | * After the command execution, type `panel --pin`. This will take the last result and move it to the _Pin Panel' panel.
12 | * While pressing the `ctrl` key, double click the result item. This will make the item _draggable_. You are now able to drag the item and drop on _Pin Panel' panel.
13 |
14 |
15 | Actions
16 | -------
17 | * To cancel an item from being _draggable_, just `ctrl`+double click on that item again.
18 | * To delete an item from _Pin Panel' panel, `ctrl`+double click that item.
19 |
20 |
21 | You can leave _Pin Panel' opened on screen, minimized or maximize by clicking the `panel` title.
22 | To close _Pin Panel' panel, click the X button which will apear when hovering the panel.
23 |
24 | Example
25 | -------
26 | Try the following
27 |
28 | ```
29 | panel
30 | man pinPanel
31 | pinPanel --pin
32 | ```
33 |
34 | Notice that this manual is now always on in the _Pin Panel'.
35 |
36 | Another Example
37 | ---------------
38 | Type `set -o`. `ctrl`+double click the result and release the buttons. Now, drag the result panel to _Pin Panel' panel, and relase the mouse.
39 | Notice the settings panel is pinned on _Pin Panel' panel.
40 |
41 | Now try to change a setting variable, for example, change the application context by typing `set app console.sys`.
42 | Notice that the settings panel is updated and always displays the updated settings state.
43 |
44 | Have fun!
45 |
46 |
--------------------------------------------------------------------------------
/docs/plugins.md:
--------------------------------------------------------------------------------
1 | Creating Management API For My App
2 | ==================================
3 | __Note:__ Please make sure to read the _extend_ manual (type `man extend`) before you continue.
4 |
5 | Creating your own management API and integrating it into the console is as easy as extending the console, as described in the `extend` manual.
6 | The only diffrence is that the API is implemented as part of your application and exposes the docRouter information as discussed earlier.
7 |
8 | In order to _plug-in_ the API into the console, use the `plugins install` command.
9 | In the following example, we're installing `mysample` API:
10 |
11 | `
12 | plugins install mysample http://mysample.com/!! -p
13 | `
14 |
15 | After executing this command, the console will get the docRouter data, compile the commands and add them to the commands available for execution.
16 | Type `help` or `help mysample` to see how this command is now part of the console command list.
17 | The `-p` switch makes the plugin persistent. This means that next time when opening the console (from the same machine), the plugin will be automatically be integrated into the console.
18 | Not using this switch will make the command available only for this session. Closing and opening the console will not load this command.
19 |
20 | This feature allows you to create your own set of APIs integrated into the console.
21 |
22 | * In order to _uninstall_ a plugin, use the `plugins uninstall` command.
23 | * In order to remove all plugins currently installed, use the `plugins reset` command.
24 |
25 | __Notes:__
26 |
27 | * The API exposed to the console should be publicly available to the console. No authentication is currently supported.
28 | * This works best in Chrome browser. IE for example has Cross Site Origin issue loading plugins from other domains.
29 |
--------------------------------------------------------------------------------
/docs/tabs.md:
--------------------------------------------------------------------------------
1 | Managing Parallel Console Sessions
2 | ==================================
3 | As you probably already know by now, the console keeps the commands history, environment variables and the installed plugins in the browser's local storage, used to restore its state when initialized.
4 |
5 | The `tabs` feature allows you to open few console `sessions`. Each such session will keep all of the storage data listed above, partitioned by the optional `name` argument.
6 | Any time, you can go back to a session by just executing the command with the same session name.
7 | This way you will be able to create few sessions, each with its own set of environment variables, history and plugins related to it.
8 |
9 | For example, the following commands will create two sessions
10 |
11 | ```
12 | tabs app1
13 | tabs app2
14 |
15 | ```
16 |
17 | Now, in each _session_ you are now able to create your own set of environment variables and install plugins.
18 |
19 |
--------------------------------------------------------------------------------
/images/demo1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/amiturgman/aCLI/e133c0cb043433da2b65c318448780d41a8d0a1d/images/demo1.png
--------------------------------------------------------------------------------
/images/demo2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/amiturgman/aCLI/e133c0cb043433da2b65c318448780d41a8d0a1d/images/demo2.png
--------------------------------------------------------------------------------
/images/web-cli-demo.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/amiturgman/aCLI/e133c0cb043433da2b65c318448780d41a8d0a1d/images/web-cli-demo.gif
--------------------------------------------------------------------------------
/lib/acli.css:
--------------------------------------------------------------------------------
1 |
2 |
3 | .cli-control {
4 | font-family: courier;
5 | font-size: 1.1em;
6 | margin: 0;
7 | color: #3d3d3d;
8 | display: block;
9 | height: 100%;
10 | }
11 |
12 | .cli-promptText {
13 | color: #808080;
14 | margin-right: 5px;
15 | float: left;
16 | }
17 |
18 | .cli-input-wrapper {
19 | overflow: hidden;
20 | }
21 |
22 | .cli-input-container-clear {
23 | clear: both;
24 | }
25 |
26 | .cli-commandRow {
27 | margin-top: 10px;
28 | }
29 |
30 | .cli-commandText {
31 | font-weight: bold;
32 | }
33 |
34 | .cli-output-warn {
35 | color: orange;
36 | }
37 |
38 | .cli-output-info {
39 | color: auto;
40 | }
41 | .cli-output-error {
42 | font-weight: bold;
43 | color: red;
44 | }
45 |
46 | .cli-tab-container {
47 | border: 1px solid #008000;
48 | background-color: red;
49 | position: absolute;
50 | top: 100px;
51 | left: 100px;
52 | width: 300px;
53 | height: 500px;
54 | }
55 |
56 |
57 |
58 | .cli-output {
59 | font-size: 1.1em;
60 | position: absolute;
61 | top: 0;
62 | bottom: 26px;
63 | left: 0;
64 | right: 0;
65 | width: 100%;
66 | overflow: auto;
67 | }
68 |
69 | .cli-output > div {
70 | padding: 5px;
71 | }
72 |
73 | .cli-pinPanel {
74 | position: absolute;
75 | top: 0;
76 | bottom: 26px;
77 | width: 40%;
78 | right: 10px;
79 | padding: 3px;
80 | background-color: #ffffef;
81 | border: 1px solid #d3d3d3;
82 | opacity: 0.9;
83 | display: none;
84 | overflow: auto;
85 | }
86 |
87 | .cli-pinPanel-close {
88 | display: none;
89 | background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB4AAAAeCAYAAAA7MK6iAAABkWlDQ1BJQ0MgUHJvZmlsZQAAeJyVkT1LHFEUhp87SCwS1gSnUotrJ7obFkWwSKNTLJIUy6Kyu93szLgujLOXO9evIm2aCJp0gSD6D2wShEDQOrESt0yTxlIEtVAYi5uwjSK+cOA5LwfOFzi/faViB1hOjK6UZmS1Vpe9HXoZBAA/SNV0ufyOB3XVQQCcFHyl4ofr7tULXa3VQbiA27Q8ArgNy28Ad80oA6IMuMGSH4IIgbyeq3ggtoFc0/IukGtY3gdyq0HTgDgEiknYSkCcA1NhlAbgjAAmUNqA8xUoVGt1aUebG4NCDziHXe/DFhz9hIGJrjc0BK/ew/fRrnfxCwGI5Eu6ODEOgBjsh+edLDvbg77PcHuUZdeXWXZzCs++wafNYEWv/ruLEMfwWG53s7n9Adi+97PdH4Ai7PyFhWFYmIePKcgDePkHSifw9gfiWPwPeysABjw/bjW0b6JQVkoz0mvHbZ0qP4ie9PbHZaJ1A+C11YZuNZeMnFYqjqTXXlYrJtJ5OZsEr/NyvFicBLgDENJ1NIrxLpQAAAAJcEhZcwAACxMAAAsTAQCanBgAAAbMSURBVEiJlZdfTFTZHce/M/fegbnMzGUY/u0w6wAKMzQwLSotCe7UxASNaHVLJsZWWzYYTA19M/VF00xaXzQaEwKGpAb71hirMawPNNGCiZq6pIjRRBtdQRk6AtKF+Xtn7r2/PnAue2ccyXqS38vJ+Z3P+f0955iw8TAxwc6dO82xWMyUTqdNsiybjh8/zouiaBoaGsoAQHFxMdntdhofH9eYLjEpOPgNgGYmnM/nE/x+v9Xn84npdJqfn58njuOcPM9zoijONzc3w+v10uzsrPzs2bPU4uKiAkAFoDH54ACmj0A5AFxFRYXQ2toqdnV1Vba0tGxqaWn5uSRJQUEQ2o0KiqI8jsVi30xNTY0ODg4+efToUUyW5czi4mKWHUDdyHowC3kA1tra2tJQKLTpypUrO2Kx2N8pb0SjUXVmZkbNn19ZWfmbz+era21tdTudTgmAle1p/hjUxBaIHo+n7MiRI1tu3br1C1VVZ4iIMpmMNjw8nOns7EwCiBmlra0tceHChUwqldLY2sd37tw5vG3btk2SJDkBiGzvDzysQ60Oh6Ns9+7dW65du/YlEclERGNjY4rX643nA/PF7/cnJicnFd36sbGxX/v9/loGtxaCcwCKAEiBQKDu3LlzexRFmSUiGhkZyXActyHQKBzHxc6ePSvr8MuXL3/pdrs/ByAxBqfDTQAEALby8nL3iRMndiwvL3+tW/opUKMMDQ1liIhisdgDAD8CUA3AxlhmPaGKHQ5HWTAYbLp69epXRESJREL1eDw57t26dWuio6PjgxhXVlbGe3t706Iors9ZLJZYJBLJEhFNTEz80ePxNAAoA1DMrIYZQIkoiu5QKLTj9evXfyUiGhgYyBg3b25uTujuC4fDsj5fX1+fiEQiGhHR8PBwjk5fX1+aiGhpaemfAAIAPmNW83p8JUmS6vfu3bsnmUw+JiJqb2/Psczr9caTySQZ4Q0NDetQIqLz58/LRh2XyxVXlLVcKy0tDQKoA1AKwAJGd1VVVTUfOHDgV0REq6uraqG4dXV1JY3w1dXVdeiNGzeyhfJhenpaJiI6derU7+12ux9AOYBiMwCTzWbjysvLrRUVFeUAEI1GC3aZ27dvq6FQKCXLMgDAbrebAODmzZtKKBRKq6r6gc7s7CwAoLa21qNp2npWmwFA0zTOZDIJqqoWA0A2my3EBQC8evWK4vF4zsGePn2qFYICgD6vaVpRIpHgGNhsBoBkMmlaWFjAy5cvUwBQXV1dcBO/328eHx+3ulwuk3HTM2fOWMLhsKWQjtvt1gBgZmYmZrVacxqIAMAtCMLP6urqejOZzAIRUX4pSZIUj0ajOTHdv39/Tsz7+/vTRh2O42IrKytZIqJAIPA7QRB+CqAGQIneuAmAJoqi8vbt2+cA0N3dnXNlNjU1mauqqnJiOjo6qoZCoVQqlQIABINBzqiza9cuzuFw8O/evXv65MmT77LZbM4tJQCoFAThJ42NjYcuXrz4F3b7ZI0NAawu+/v70/nZ29bWlgiHw3K+l+7du5cgIhodHR0F8EsAPwZQhbW+vVZOAJqKior2ejyeP0QikalCdfkp0tPTk2Itc97lcp0CsAdAE1g5AayBAKjjef6LsrKy3mPHjg3rcevp6Ul9KrSjoyOZzWZVIqLBwcGbAL4C8AUMDUS/KTgAnKZpQiaTKZ6bm+NKSkpW29ramg4ePMgTESYmJgrXS944evQof/369SKLxWJ+8ODBN93d3f8AMAdgAcAKgDSALMAuCaw18C0AghzH/dbpdP55YGDglm758+fP04cOHUrlx12Xzs7O5MOHD9dT/P79+/8G8CcAvwEQZHuvXxL6K5LH2l1pYzGo4TjOa7PZ6g8fPtx0+vTpppqamgYAkGVZe/HihTI5OUkAEAgE0NjYyDkcDh4AlpeX50dGRv5z8uTJfwH4FsAsgAiAJQBxADIAVS9mjsGLATgY/DOO4zxFRUWfJ5PJmkuXLjXu27evfPPmzb5CLn7z5s23d+/efd/X1/csm83OAXjLXPxfBl1lblYAaDpYj7PA4Hbmliom1VartTKVSpVJklS6ffv2ivb2dicATE1NrUxPTy9FIpH3AJZZLKMA3jFZZuHQY6sCIOP7R4dbDG6XADixVm5lWMtIG8/zVgC8oijgeV7RNC2laVocwHcM9B7A/1gy6e7NwPDMzX/16Y94gR3ACqCEecDODiPi+7cT2GYygCSD6AmXAJBiwCy+f9yvW5k/9F8Ez0T3gC4W5L6TNazFLcMOoEuGzSso8JsoBDbO64cwfmlMBfT0f5Lxy2KE/aAvzMfGD1274VdFH/8HBejinPCjSboAAAAASUVORK5CYII=);
90 | height: 30px;
91 | width: 30px;
92 | background-color: transparent;
93 | position: absolute;
94 | left: 3px;
95 | top: 2px;
96 | }
97 |
98 | .cli-pinPanel:hover .cli-pinPanel-close { /* when hovering a note- display its close button */
99 | display: block;
100 | }
101 |
102 | .cli-pinPanel-title {
103 | background-color: #ffffad;
104 | font-weight: bold;;
105 | text-align: center;
106 | font-size: 1.2em;
107 | cursor: pointer;
108 | padding: 5px;
109 | }
110 |
111 | .cli-pinPanel-item {
112 | margin-top: 5px;
113 | }
114 |
115 | .cli-input-container {
116 | position: absolute;
117 | height: 22px;
118 | bottom: 0;
119 | left: 0;
120 | right: 0;
121 | border: 1px solid #808080;
122 | vertical-align: bottom;
123 | background-color: white;
124 | padding: 3px 2px 0 2px;
125 | text-align: left;
126 | }
127 |
128 | .cli-input{
129 | font-size: 0.9em;
130 | border: 0px solid black;
131 | outline: none;
132 | background-color: transparent;
133 | font-family: courier new;
134 | font-weight: bold;
135 | width: 100%;
136 | color: black;
137 | }
138 |
139 | .cli-table {
140 | border-collapse: collapse;
141 | empty-cells: show;
142 | border: 1px solid gray;
143 | }
144 |
145 | .cli-table td, th {
146 | padding: 2px 3px 2px 3px;
147 | vertical-align: top;
148 | text-align: left;
149 | }
150 | .cli-table td {
151 | background-color: #eeeeee;
152 | }
153 | .cli-table th {
154 | color: blue;
155 | background-color: #eeeeda;
156 | }
157 |
158 | .cli-jsonview-control .metadataField
159 | {
160 | background-color: #eeeeee;
161 | font-weight: bold;
162 | }
163 |
164 | .cli-jsonview-control .metadataFieldCollapsed
165 | {
166 | background-color: #edd3d6;
167 | }
168 |
169 | .cli-jsonview-control .metadataValue
170 | {
171 | background-color: #eeeeda;
172 | }
173 |
174 | .cli-jsonview-control table {
175 | border-collapse:collapse;
176 | empty-cells:show;
177 | font-family: courier;
178 | }
179 |
180 | .cli-jsonview-control table td {
181 | border: 1px silver solid;
182 | padding: 2px 3px 2px 3px;
183 | vertical-align: top;
184 | text-align: left;
185 | word-wrap: normal;
186 | }
187 |
--------------------------------------------------------------------------------
/lib/acli.js:
--------------------------------------------------------------------------------
1 |
2 | (function( $ ){
3 | var defaultSessionIdCounter = 0;
4 |
5 | function invoke(context, method) {
6 | methods[method]()
7 | }
8 |
9 | var methods = {
10 | init: function(opts){
11 |
12 | // for each selected control, initialize.
13 | // return the wrapped collection
14 | return this.each(function(){
15 |
16 | var $this = $(this),
17 | data = $this.data('cli');
18 |
19 | // control already initialized, return it
20 | if (data) return $this;
21 |
22 | // construct internal elements
23 | var cliOutput = $('
').addClass('cli-output');
24 | $this.append(cliOutput);
25 |
26 | var pinPanel = $('
').addClass('cli-pinPanel')
27 | .append($('
').addClass('cli-pinPanel-close'))
28 | .append($('
').addClass('cli-pinPanel-title').text('Pin Panel'));
29 |
30 | $this.append(pinPanel);
31 |
32 | var cliInput = $('').addClass('cli-input').attr('type', 'text');
33 | var cliPrompt = $('
').addClass('cli-promptText');
34 | var inputContainer = $('
').addClass('cli-input-container')
35 | .append(cliPrompt)
36 | .append($('
').addClass('cli-input-wrapper').append(cliInput))
37 | .append($('
').addClass('cli-input-container-clear'));
38 |
39 | $this.append(inputContainer);
40 |
41 | opts.promptControl = cliPrompt;
42 | var options = $.extend(true, {}, $.fn.cli.defaults, opts);
43 |
44 | // the plugin hasn't been initialized yet
45 | var sessionId = (queryObject.get('sid') || options.sid || 'auto'+(defaultSessionIdCounter++)) + '_',
46 | envStorageKey = sessionId + 'env',
47 | pluginsStorageKey = sessionId + 'commands',
48 | historyStorageKey = sessionId + "history",
49 | resultsContainer = $("
").appendTo(cliOutput),
50 | promptControl = cliPrompt,
51 | panel = new PinPanel(),
52 | history = new History(),
53 | env = new Environment(),
54 | commands = new Commands(options.commands),
55 | systemParams = [],
56 | plugins = new Plugins();
57 |
58 | data = {
59 | input : cliInput,
60 | options: options,
61 | history: history,
62 | commands: commands,
63 | plugins: plugins,
64 | env: env,
65 | writeMessage: writeMessage
66 | };
67 |
68 | // store control data
69 | $(this).data('cli', data);
70 |
71 | // register keyboard events
72 | cliInput.keydown(function(e) {
73 | if(e.keyCode==9) { // ignore tab keys
74 | e.preventDefault();
75 | return;
76 | }
77 | handleKeyPress(e.keyCode);
78 | });
79 |
80 | writeMessage('info', options.welcomeMessage);
81 | writeMessage('info', ' ');
82 |
83 | addDefaultCommands();
84 | addSystemParams();
85 |
86 | plugins.init();
87 |
88 | cliInput.focus();
89 |
90 | console.log("cli control initialized");
91 |
92 |
93 | // *********************
94 | // private methods
95 | // *********************
96 |
97 | function writeMessage(type, msg) {
98 | $("
").addClass('cli-output-'+type).html(msg).appendTo(resultsContainer);
99 | scrollDown();
100 | }
101 |
102 | function handleKeyPress(key) {
103 | switch(key) {
104 | case 9: // tab- do nothing
105 | break
106 | case 13: // enter
107 | var command = getCommand();
108 | if(!command) return;
109 | var row = $("
")
110 | .append($("").html(new Date().toLocaleTimeString() +'>'))
111 | .append($("").html(command));
112 | resultsContainer.append(row);
113 | scrollDown();
114 | history.add(command);
115 | // todo: validate command
116 | clearCommand();
117 | parseAndExecuteCommand(command);
118 | break;
119 | case 27: // esc
120 | clearCommand();
121 | break;
122 | case 38: // up in history
123 | setCommand(history.getPrevious());
124 | break;
125 | case 40: // down in history
126 | setCommand(history.getNext());
127 | break;
128 | default:
129 | //alert(e.keyCode);
130 | }
131 | }
132 |
133 | function getCommand() {
134 | return cliInput.val().trim();
135 | }
136 |
137 | function setCommand(command) {
138 | cliInput.focus().val('');
139 | setTimeout(function(){
140 | cliInput.val(command);
141 | }, 1);
142 | }
143 |
144 | function clearCommand() {
145 | cliInput.val("");
146 | }
147 |
148 | function scrollDown() {
149 | resultsContainer.parent().animate({scrollTop: resultsContainer.height()}, 0);
150 |
151 | // remove rows based on maxResults
152 | var maxResults = parseInt(env.env('maxResults'));
153 | var rows = resultsContainer.find('.cli-commandRow');
154 | while(rows.length > maxResults) {
155 | removeLastLine();
156 | rows = resultsContainer.find('.cli-commandRow');
157 | }
158 |
159 | function removeLastLine() {
160 | resultsContainer.find('div').first().remove();
161 | }
162 | }
163 |
164 | function parseAndExecuteCommand(commandLine) {
165 |
166 | var commandInfo;
167 | try {
168 | commandInfo = parseCommand(commandLine);
169 | if(commandInfo) {
170 | executeCommand(commandInfo.command, commandInfo.args);
171 | }
172 | }
173 | catch(error) {
174 | console.error(error.message);
175 | writeMessage('error', error.message);
176 | return;
177 | }
178 | }
179 |
180 | function parseCommand(commandLine) {
181 | console.log('parsing command line:', commandLine);
182 |
183 | var tokens = tokenize(commandLine),
184 | commandName = tokens[0],
185 | command = commands.get(commandName),
186 | isGroupCommand = command && !command.exec;
187 |
188 | // check if this is a sub-command
189 | if(isGroupCommand) {
190 | if(tokens.length<2) {
191 | writeMessage('info', 'please select command for: '+commandName);
192 | parseAndExecuteCommand('help '+commandName);
193 | return;
194 | }
195 | commandName += ' ' +tokens[1];
196 | command = commands.get(commandName);
197 | }
198 |
199 | if(!command) {
200 | writeMessage('error', "command '"+commandName+"' not found");
201 | return;
202 | }
203 |
204 | var args = {}, paramsFromCommand = {};
205 | tokens = tokens.slice(isGroupCommand ? 2 : 1);
206 | console.log(command, tokens);
207 |
208 | var i =0;
209 |
210 | // get params from command line
211 | while(i").appendTo(resultsContainer)
479 |
480 | // todo: move following code to PinPanel class
481 | .dblclick(function (e) {
482 | if (!e.ctrlKey) return;
483 |
484 | if ($(this).parent().is('.cli-pinPanel-item')) {
485 | if (liveInterval) clearInterval(liveInterval);
486 | $(this).remove();
487 | }
488 | else {
489 | if ($(this).data("isDraggable")) {
490 | $(this).draggable('destroy');
491 | $(this).data("isDraggable", false);
492 | }
493 | else {
494 | $(this)
495 | .draggable({
496 | appendTo: 'body',
497 | scroll: false,
498 | helper: 'clone',
499 | cursorAt: { left: 0, top: 0 },
500 | delay: 100,
501 | opacity: 0.5,
502 | revert: 'invalid',
503 | revertDuration: 300
504 | });
505 | $(this).data("isDraggable", true);
506 | }
507 | }
508 | });
509 |
510 | var progressControl = $("");
511 | var isLive = args.live;
512 | var isPin = args.pin;
513 |
514 | var liveInterval;
515 | var liveCount = 0;
516 | var maxLiveCount = env.env('liveIterationsCount');
517 | if (isLive)
518 | liveInterval = setInterval(function () {
519 | liveCount++;
520 | execCommandInternal();
521 | }
522 | ,args.live * 1000);
523 |
524 | execCommandInternal();
525 | function execCommandInternal() {
526 | if (liveCount >= maxLiveCount) {
527 | clearInterval(liveInterval);
528 | console.log('stopping live interval for command', command);
529 | return;
530 | }
531 | var promise = {
532 | resolve: function(result) {
533 | appendExecutionResult(result);
534 | },
535 | setProgress: function (progress) {
536 | if (liveCount === 0)
537 | progressControl.html( (progress*100).toString().substr(0, 2) + '% completed... ');
538 | }
539 | };
540 |
541 | var execContext = { appcontext: options.context }
542 | execContext.createPromise = function() {
543 | return promise;
544 | }
545 |
546 | // we copy the command so that handlers will not be able to change its properties
547 | execContext.command = jQuery.extend(true, {}, command);
548 | execContext.env = jQuery.extend(true, {}, env.env());
549 | execContext.scrollDown = scrollDown;
550 |
551 | var res = command.exec(args, execContext);
552 | var img = $("![]()
").attr('src', $.fn.cli.images.processing);
553 |
554 | if(res!==promise)
555 | appendExecutionResult(res);
556 | else if (liveCount === 0)
557 | appendExecutionResult($("
").html('processing... ')
558 | .append(progressControl)
559 | .append(img));
560 |
561 | function appendExecutionResult(result) {
562 |
563 | if(typeof result == 'object' && !(result instanceof jQuery))
564 | result = jsonToHtml(result, true);
565 |
566 | resultContainer.html("").append(result);
567 |
568 | if (isPin) {
569 | panel.addItemToPinPanel(resultContainer);
570 | pinPanel.show();
571 | }
572 | else
573 | if (!isLive || liveCount === 0) scrollDown();
574 | }
575 | }
576 | }
577 |
578 | function addSystemParams() {
579 | systemParams.push({
580 | name: 'live',
581 | description: 'makes command refresh every X seconds',
582 | type: 'number',
583 | defaultValue: 5
584 | });
585 |
586 | systemParams.push({
587 | name: 'pin',
588 | description: 'pins the result on the panel',
589 | type: 'boolean'
590 | });
591 |
592 | systemParams.forEach(function(param){
593 | param.system = true;
594 | });
595 | }
596 |
597 | function addDefaultCommands() {
598 |
599 | var helpCommand = {
600 | name: 'help',
601 | description: 'Gets help for working with the console',
602 | usage: 'help [command name]',
603 | manual: '',
604 | params: [
605 | {
606 | name: 'command',
607 | description: 'The command to get help for',
608 | type: 'string',
609 | defaultValue: ''
610 | },
611 | {
612 | name: 'subCommand',
613 | description: 'The sub-command to get help for',
614 | type: 'string',
615 | defaultValue: ''
616 | }
617 | ],
618 | exec: function(args, context) {
619 |
620 | var tbl = $("");
621 |
622 | // if someone for some reason uses the named version, this should be checked...
623 | if(args.subCommand && !args.command) {
624 | return "please specify command group name in addition to sub-command '"+args.subCommand+"'";
625 | }
626 |
627 | var commandName = args.command + (args.subCommand ? ' ' + args.subCommand : '');
628 |
629 | if(commandName) {
630 | var command = commands.get(commandName);
631 |
632 | if(!command) {
633 | return "command '"+commandName+"' not found";
634 | }
635 |
636 | if(command.exec) { // this is a regular command
637 |
638 | var descr = command.description || '';
639 | if(options.descriptionHandler) descr = options.descriptionHandler(command, descr);
640 | tbl.append($("
| ").html('Description')).append($(" | ").html(descr))); 641 | 642 | tbl.append($(" | ||||||||||||||||||||||||||||
| ").html('Usage')).append($(" | ").html(command.usage || ''))); 643 | tbl.append($(" | ||||||||||||||||||||||||||||
| ").html('Example')).append($(" | ").html(command.example || '')));
644 |
645 | if(command.params && command.params.length) {
646 |
647 | var paramsTbl = $("
|