nlc

NLC 💾

A terminal assistant for natural language commands.

npm | Buy Me a Coffee

Table of Contents

• ⚠️ Prerequisites
• ⚡ Installation
• ✨ Usage
• 🔮 Commands
• 🤝 Contributing
• ⭐ Support
• 📜 License

Prerequisites

• Node.js and npm must be installed on your system. You can download them from nodejs.org.
• You must have a valid OpenAI API key to use NLC. You can get one from platform.openai.com/account/api-keys.

Installation

To install NLC, you need Node.js and npm installed on your machine. You can install the CLI tool globally using the following command:

npm install -g nlc

Usage

After installation, you can run the CLI tool using the following command:

nlc [command] [options]

To see a list of available commands and options, run:

nlc --help

Commands

config

Manage configuration settings for NLC.

OpenAI

nlc config provider openai

nlc config key <your_openai_api_key>

nlc config model "gpt-4o-mini"

LM Studio

nlc config provider lmstudio

nlc config base_url "http://127.0.0.1:1234"

nlc config model "meta/llama-3.3-70b"

do

Execute a natural language request using NLC.

nlc do "list all the Docker containers"
nlc do "write me a port scanner in Bash"

Options:

• --file: Optional file to include with your request (e.g., for context or input data).

Contributing

We welcome contributions from the community! If you'd like to contribute, please follow these steps:

• Fork the repository.
• Create a new branch for your feature or bugfix.
• Make your changes and commit them with a descriptive commit message.
• Push your changes to your fork.
• Open a pull request with a detailed description of your changes.

Support

If you find this project useful, please consider supporting it by giving it a star on GitHub. Your support helps us continue to improve and maintain the project.

You can also support the project by making a donation. Every little bit helps and is greatly appreciated!

Thank you for your support!

License

This project is licensed under the MIT License. See the LICENSE file for details.

Thank you for using NLC! If you have any questions or feedback, please open an issue on GitHub.