https://github.com/tzador/englishell
Translate plain english commands to shell commands and execute
https://github.com/tzador/englishell
chatg nlp nodejs productivity shell
Last synced: about 1 year ago
JSON representation
Translate plain english commands to shell commands and execute
- Host: GitHub
- URL: https://github.com/tzador/englishell
- Owner: tzador
- License: mit
- Created: 2023-08-10T00:55:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T16:04:51.000Z (over 1 year ago)
- Last Synced: 2025-04-19T20:16:44.221Z (about 1 year ago)
- Topics: chatg, nlp, nodejs, productivity, shell
- Language: JavaScript
- Homepage: https://englishell.js.org
- Size: 180 KB
- Stars: 37
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# englishell
A command-line tool that translates English instructions into shell commands using OpenAI's GPT-3.5, making terminal operations more intuitive and accessible.
## Features
- Translates natural language to shell commands
- Works on macOS and Linux
- Provides detailed explanations for each command
- Requires confirmation before execution
- Available as both `englishell` and `e` commands for convenience
## Installation
```bash
npm install -g englishell
```
## Prerequisites
You need to have an OpenAI API key set in your environment variables:
```bash
export OPENAI_API_KEY='your-api-key-here'
```
## Usage
Simply type your instruction in plain English after the command:
```bash
englishell [your instruction]
# or use the short form
e [your instruction]
```
### Examples
1. **Finding large files**
```bash
$ englishell find all files larger than 100MB in my home directory
$ find ~/ -type f -size +100M
This command searches your home directory (~/) for files (-type f) that are larger
than 100 megabytes (-size +100M). The results will show the full path to each file
that matches these criteria.
```
2. **Process management**
```bash
$ englishell show me all running node processes
$ ps aux | grep node
This command lists all running processes (ps aux) and filters the results to show
only those containing "node" in their description. The output will show the process
ID, CPU usage, memory usage, and other details for each Node.js process.
```
3. **System information**
```bash
$ englishell show system memory usage
$ free -h
This command displays the system's memory usage in a human-readable format (-h).
It shows total memory, used memory, free memory, shared memory, and available memory,
as well as swap usage statistics.
```
## How It Works
1. Your English instruction is sent to OpenAI's GPT-3.5 model
2. The AI generates an appropriate shell command and explanation
3. The command and explanation are displayed for your review
4. You can press Enter to execute the command or input a follow-up instruction
5. The command is executed in your default shell
## Supported Platforms
- macOS
- Linux
## Security
- All commands are shown before execution
- Requires explicit confirmation (Enter key) before running any command
- You can review the explanation and command before execution
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.