Skip to content

Repository files navigation

Console LicenseNPM version

Web console used in Cloud Commander.

Console

Install

npm i console-io -g

Use as standalone

Start console, go to url http://localhost:1337

Hot keys

KeyOperation
Ctrl + Zcancel input
Ctrl + Lclear screen
Ctrl + Ckill running task

For more details see Jq-console keyboard shortcuts.

API

Client API

Console(element [, options])

  • element - html element, or selector
  • options - (optional) {cwd}

When prefix set in server and client, you should use same prefix in html. For example, if you use prefix "any_prefix" you should connect console script in this way:

<script src="/any_prefix/console.js"></script>

addShortCuts(shortCuts)

  • shortCuts - object contain big letter and function.

Example: show alert on Ctrl + A:

async()=>{constkonsole=awaitConsole();konsole.addShortCuts({A(){alert('hello');},});};

getPromptText()

Get text of prompt.

setPromptText(text)

  • text - string of new text

Set new text of prompt.

focus()

Set focus on Console.

Server API

Console(options)

Could be used as middleware, or for init Console.

Console.listen(socket,{
server,// when no socketonline: true,// defaultprefix: '/console',// defaultprefixSocket: '/console',// defaultauth: (accept,reject)=>(username,password)=>{accept();},});

Console.middle(options)

Middleware function if there is a need of init socket in another place.

Console({prefix: '/console',// defaultonline: true,// default});

Use as middleware

To use Console in your programs you should make local install:

npm i console-io express

And use it in your program

// server.jsimporthttpfrom'node:http';import{konsole}from'console-io';importexpressfrom'express';constapp=express();constserver=http.createServer(app);constport=1337;constip='0.0.0.0';constonline=true;app.use(konsole({
server,
online,// load jquery and socket.io from cdn})).use(express.static(__dirname));konsole.listen({
server,});server.listen(port,ip);
<!-- index.html --><divclass="console"></div><scriptsrc="/console/console.js"></script><script>document.addEventListener('load',async()=>{constkonsole=awaitConsole('.console',{prefix: 'console',env: {CURRENT_FILE: getCurrentFile(),CURRENT_APP: 'console-io'}});console.log('console ready')konsole.focus();functiongetCurrentFile(){return'filename.txt';}});</script>

License

MIT

Releases

Packages

Used by

Contributors

Languages