jshell

JShell - WIP

JShell is a JavaScript based unix shell that allows you to execute unix commands and JavaScript code directly in your terminal. The configs and scripts are also pure JavaScript, which allows you to extend your shell with npm modules directly.

Demo

Installation

Run npm install -g jshell-node.

In your terminal of choice change the executed command to jshell.

Example configuration file

const fs = require('fs');
const path = require('path');
 
module.exports = function (shell) {
    return {
        prompt: () => {
            const time = new Date().toLocaleTimeString().green;
            const cwd = shell.cwd.cyan;
            const sign = '$'.yellow;
 
            const isGitRepo = fs.existsSync(path.join(shell.absoluteCwd, '.git'));
            let gitBranch = isGitRepo ? shell.exec('git rev-parse --abbrev-ref HEAD').trim() : 'not a repo';
            gitBranch = ('{' + gitBranch + '}').red;
 
            return `${time} ${cwd} ${gitBranch} ${sign} `;
        }
    }
};

Supported platforms

• Linux
• Windows
• Mac OS

Features completion

• Execute unix commands
• Configuration file
  • - Prompt
  • - Env
  • - Others?
• Autocomplete based on files
• Autocomplete from bash completion files
• Execute JavaScript inside the shell
• Multiple commands - &&
• Multiline - \
• Pipes - |
• Background processes - &
• More?

Local development

node v6 is required

• Clone the repo
• Run the shell with node index.js
• For debugging run with node --debug=5858 index.js and attach a remote node debugger
• There are no tests just yet, but stay tuned for those

Contributing

• Fork the repo
• Clone it
• Commit your changes
• Submit PR

Make sure to keep the code style the same.

License

The MIT License (MIT)
Copyright (c) 2016 JShell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.