Natural Language Terminal (NLT)

repo owner: Balaji Rama (balajirw10@gmail.com)

Welcome to the future of command-line interfaces.

Natural Language Terminal (NLT) revolutionizes the way you interact with your system, bringing the power of natural language processing to your fingertips.

Overview • Features • Installation • Usage • Plugins • Contributing • License

---

Note: We currently only support MacOS. Windows compatibility is still under development.

📦 1. Get Started

1.1 Prerequisite

Install Xcode from the Mac App Store:

Open the Mac App Store Search for "Xcode" Click "Get" or "Install" The download might take a while as Xcode is a large application (several GB)

Once Xcode is fully installed, then try running the command again:

sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer

1.2 Python Setup

This project is developed using Python 3.10. Follow these steps to set up your environment on Mac:

1. Install Python 3.10 using Homebrew:

brew install python@3.10

2. Link Python 3.10:

brew link python@3.10

3. Add Python aliases to your shell configuration:

echo 'alias python="/opt/homebrew/bin/python3.10"' >> ~/.zshrc
echo 'alias python3="/opt/homebrew/bin/python3.10"' >> ~/.zshrc

4. Apply the changes:

source ~/.zshrc

5. Verify your Python installation:

python --version  # Should show Python 3.10.x
python3 --version  # Should show Python 3.10.x

1.3 Installing Project Dependencies

1. Install the natural-language-terminal package from source:

python -m pip install -e .

2. Install required system utilities:

python -m pip install psutil
python -m pip install requests

2 Usage

2.1 NL session initialization

nlt init

2.2 Creating a New Environment

nlt create newEnv

After running this command, a folder called newEnv will be created. We have uploaded the exampleEnv folder as an example for reference. See the exampleEnv subfolder.

2.3 Activating an Environment

source newEnv/bin/activate

2.4 Deactivating

For both macOS and Windows:

remove

2.5 get NLT suggestions

Now you can chat with the terminal to receive command suggestions and choose whether to run them.

🤝 4. Contributing

We welcome contributions! Please see our CONTRIBUTING.md for details on how to get started.

---

"Speak to your terminal, and it shall listen."

Star History