{"id":19520292,"url":"https://github.com/henryhale/viteshell","last_synced_at":"2025-04-26T07:31:37.608Z","repository":{"id":187225007,"uuid":"676470032","full_name":"henryhale/viteshell","owner":"henryhale","description":"✴️ A minimalistic shell implementation written in TypeScript.","archived":false,"fork":false,"pushed_at":"2024-08-22T01:57:31.000Z","size":369,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-15T11:44:09.404Z","etag":null,"topics":["bash","henryhale","shell","terminal","typescript"],"latest_commit_sha":null,"homepage":"https://viteshell.js.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/henryhale.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-09T09:15:55.000Z","updated_at":"2024-10-11T17:21:27.000Z","dependencies_parsed_at":"2023-12-08T09:25:06.231Z","dependency_job_id":"71d0efd7-f35a-4dbb-8e05-68f04792e0f7","html_url":"https://github.com/henryhale/viteshell","commit_stats":null,"previous_names":["henryhale/viteshell"],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryhale%2Fviteshell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryhale%2Fviteshell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryhale%2Fviteshell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/henryhale%2Fviteshell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/henryhale","download_url":"https://codeload.github.com/henryhale/viteshell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250953613,"owners_count":21513399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","henryhale","shell","terminal","typescript"],"created_at":"2024-11-11T00:24:50.572Z","updated_at":"2025-04-26T07:31:33.807Z","avatar_url":"https://github.com/henryhale.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg width=\"45\" src=\"./media/logo.jpg\"/\u003e\n\u003ch1\u003eviteshell\u003c/h1\u003e\n\u003cp\u003eA minimalistic shell implementation written in TypeScript.\u003c/p\u003e\n\u003cimg alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/henryhale/viteshell/release.yml\"\u003e\n\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/viteshell\"\u003e\n\u003cimg alt=\"GitHub release (latest SemVer)\" src=\"https://img.shields.io/github/v/release/henryhale/viteshell\"\u003e\n\u003cimg alt=\"npm bundle size\" src=\"https://img.shields.io/bundlephobia/minzip/viteshell\"\u003e\n\u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/henryhale/viteshell\"\u003e\n\u003c/div\u003e\n\n## What is `viteshell`?\n\n`viteshell` comes from [vite](https://en.wiktionary.org/wiki/vite), a French word for \"quick\" and [shell](https://en.wikipedia.org/wiki/Unix_shell), a program that executes other programs in response to text commands.\n\n`viteshell` is lightweight shell implementation written in TypeScript that tends to work just like [bash](https://www.gnu.org/software/bash/). It is intended for use with [xterminal](https://github.com/henryhale/xterminal) but can as well be used elsewhere.\n\n## Key Features\n\n- **Perfomant**: It is lightweight and really fast.\n- **Efficient Execution**: Commands are executed asynchronously (with promises).\n- **TypeScript Support**: Type declaration files are provided for smooth development.\n- **Shell Expansion**: Variable and alias substitution\n- **Command Chaining \u0026 Pipes**: Piping \u0026 Chaininig commands using `;`, `|`, `\u0026\u0026` and `||`\n- **Builtin Commands**: Contains commands such as _exit, clear, pwd, echo, alias, unalias, export, history \u0026 help_.\n- **NodeJS-like Process object**: Contains _env, argv, stdout, and more_.\n- **Alias**: Manage command aliases\n- **Environment Variables**: Manage command aliases\n- **Backup \u0026 Restore**: Save or restore the shell state\n- **Abort signal**: Execution of a command can be aborted\n- **Execution Timeout**: Command execution time limit\n\n\u003e **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.  \n\n## Documentation\nTo get started with `viteshell`, read the [documentation here](https://viteshell.js.org).\n\n## Live Demo\nThe demo allows you to explore the features of `viteshell` and interact with the key functionalities.\nClick the link below to access the live demo:\n\n[🚀 Live Demo](https://henryhale.github.io/vix)\n\n## Browser Support\n\nPromises and some other latest ECMAScript features are used in the source code.\nSupporting 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.\n\n## Development\n\nTo get started with development, follow these steps:\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org) (\u003e=14)\n- [pnpm](https://pnpm.io/) (\u003e=7)\n\n### Setup\n\n1. Clone this repository: `git clone https://github.com/henryhale/viteshell.git`\n2. Navigate to the project directory: `cd viteshell`\n3. Install dependencies: `pnpm install`\n4. Development: `pnpm dev`\n5. Run tests using: `pnpm test`\n\n### Building the Library\n\nTo build the library, run `pnpm build`\n\nThis will generate the production-ready distribution files in the `dist` directory.\n\n## License\n\nCopyright (c) 2023-Present [Henry Hale](https://github.com/henryhale).\n\nReleased under the [MIT License](https://github.com/henryhale/viteshell/blob/master/LICENSE.txt).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhenryhale%2Fviteshell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhenryhale%2Fviteshell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhenryhale%2Fviteshell/lists"}