AI X Terminal

AI X Terminal is a command-line tool that leverages OpenAI's API to enhance your terminal experience with AI capabilities. With options to append file contents or entire workspaces to requests, AI Terminal facilitates seamless integration with your current projects.

Installation

npm install -g ai-x-terminal

OR

bun add -g ai-x-terminal

Features

• Command Line Arguments: Use the tool with various options to customize its behavior.

  • -f, --file <file>: Append specified file content to the AI prompt.
  • -w, --workspace: Append contents of all files in the current directory to the prompt.

• OpenAI Integration:

  • Upon first run, you will be prompted to input your OpenAI API key, which will be securely stored for future use.

Usage Examples

After installing AI X Terminal globally, you can use it via the command line as demonstrated below:

Basic Usage

To use the AI X Terminal for a simple command, just type:

ax "What is the purpose of life?"

This will prompt the AI to answer your query based on the supplied string.

Using a File

You can append the content of a specific file to the AI request. This is especially useful if you want the AI's response to consider the context or information contained within a file.

ax -f example.txt "Summarize this file."

In this example, example.txt is read by the AI, and it provides a summary based on the file contents.

Using the Current Workspace

If you want the AI to consider all files within the current directory, use the workspace option:

ax -w "Provide an overview of this project."

This command will read all files in the current directory and generate a response based on the combined contents of those files.

Note

Feel free to contribute or raise issues if you encounter any!

Disclaimer: Make sure to keep your API key confidential and never share it publicly.

Upcoming Features

• Set custom prompt: Allow users to set a custom prompt for the AI.
• Multiple API support: Integrate with other AI APIs for enhanced functionality.
• Contextual AI: Implement a feature to maintain context across multiple requests.