Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 3.46 KB

README.md

File metadata and controls

76 lines (53 loc) · 3.46 KB
Raw

viteshell

A minimalistic shell implementation written in TypeScript.

GitHub Workflow Status npm GitHub release (latest SemVer) npm bundle size GitHub

What is viteshell?

viteshell comes from vite, a French word for "quick" and shell, a program that executes other programs in response to text commands.

viteshell is lightweight shell implementation written in TypeScript that tends to work just like bash. It is intended for use with xterminal but can as well be used elsewhere.

Key Features

  • Perfomant: It is lightweight and really fast.
  • Efficient Execution: Commands are executed asynchronously (with promises).
  • TypeScript Support: Type declaration files are provided for smooth development.
  • Shell Expansion: Variable and alias substitution
  • Command Chaining & Pipes: Piping & Chaininig commands using ;, |, && and ||
  • Builtin Commands: Contains commands such as exit, clear, pwd, echo, alias, unalias, export, history & help.
  • NodeJS-like Process object: Contains env, argv, stdout, and more.
  • Alias: Manage command aliases
  • Environment Variables: Manage command aliases
  • Backup & Restore: Save or restore the shell state
  • Abort signal: Execution of a command can be aborted
  • Execution Timeout: Command execution time limit

Note: Currently, viteshell only provides a platform for handling some basic shell operations. Support for other functionalities like input/output redirection, shell scripts, complex shell expansion and job control is not provided.

Documentation

To get started with viteshell, read the documentation here.

Live Demo

The demo allows you to explore the features of viteshell and interact with the key functionalities. Click the link below to access the live demo:

🚀 Live Demo

Browser Support

Promises and some other latest ECMAScript features are used in the source code. Supporting a wide range of browsers is the goal. Modern browsers, most specifically the latest versions of Chrome, Firefox, Safari, and Edge (for desktop and mobile devices) are supported.

Development

To get started with development, follow these steps:

Prerequisites

Setup

  1. Clone this repository: git clone https://github.com/henryhale/viteshell.git
  2. Navigate to the project directory: cd viteshell
  3. Install dependencies: pnpm install
  4. Development: pnpm dev
  5. Run tests using: pnpm test

Building the Library

To build the library, run pnpm build

This will generate the production-ready distribution files in the dist directory.

License

Copyright (c) 2023-Present Henry Hale.

Released under the MIT License.