TermAI - A Command Line AI Assistant

Catchy AI-generated intro:

TermAI is a Command Line AI that brings the power of artificial intelligence right to your terminal. Imagine having an intelligent assistant that can chat, suggest commands, and explain complex CLI instructions without ever having to leave your terminal. Boost your productivity and streamline your workflow with TermAI!

TermAI is packed with features designed to make your command line experience smarter and more efficient. With TermAI, you can engage in natural language conversations, get instant command suggestions tailored to your needs, and receive detailed explanations of complex commands. Whether you're a seasoned developer or a command line novice, TermAI is here to assist you every step of the way.

Table of contents

• Introduction
  • Table of contents
  • Before getting started
  • Supported Providers
    • Obtaining API Keys
• Getting Started
  • Requirements
  • Clone the Repository
  • Install the application
  • Getting updates
• Usage
  • Key Features
    • chat
    • suggest
    • explain
• Disclaimer
  • Disclaimer on AI-Generated Content

Supported Providers

• ✅ OpenAI
• ✅ Anthropic

Support for additional provides is not planned at this time, but may be requested.

Obtaining API Keys

You will need to obtain API keys from LLM providers. Follow the provider's instructions to generate and retrieve your API key.

Getting Started

To get started with this project, follow the steps below.

Requirements

• The Rust programming language

Linux

On Linux you may need to install additional packages for compilation to finish successfully:

• pkg-config
• libssl-dev
• libdbus-1-dev

Install the application

Use Cargo to install

cargo install termai

You're all set!

You can now start using the project. For further instructions, refer to the usage section.

To update to the latest version, simply use the install command.

Usage

Run termai to start the program. Initially you will have to setup a provider with an API key. API keys are encrypted and stored securely and never leave your machine, except when used to authenticate with LLM providers.

You can setup a provider by running termai and selecting Options. After setting up a provider you can change the model by going back into the Options menu.

Use termai --help to see all available commands.

Key Features

chat

Start a conversational style chat with the AI. Conversations are forgotten when the program exits.

Slash commands are available in chat mode. Type /help to see a list of available commands.

Quick access: termai chat

Quicker access termai chat hello world

Help: termai chat --help

suggest

Get a suggested CLI command based on your input.

Quick access: termai suggest

Quicker access: termai suggest list all files

Help: termai suggest --help

explain

Get a CLI command explained.

Quick access: termai explain

Quicker access: termai explain ls -alF

Help: termai explain --help

Disclaimer

TermAI is provided "as is", without warranty of any kind, as stated in the MIT License. The developers and contributors are not liable for any loss of API keys, data, or any other issues that may arise from using this software. Use it at your own risk.

Disclaimer on AI-Generated Content

The content generated by TermAI's AI functionalities, including but not limited to chat responses, command suggestions, and explanations, is provided for informational purposes only. The developers and contributors of TermAI do not guarantee the accuracy, completeness, or usefulness of any AI-generated content. Users are advised to verify the information independently and use it at their own discretion. The developers and contributors are not responsible for any consequences resulting from the use of AI-generated content.