Welcome to the future of command line interfaces! Shell-AI allows you to interact with your terminal using natural language, transforming the way you write shell commands. With this intuitive tool, you can describe your intention in plain English and receive precise command suggestions. Let’s dive into how to set up and utilize this remarkable application effectively!

Installation

Getting started with Shell-AI is a breeze. Follow these simple steps to install this powerful CLI utility:

• Open your terminal.
• If you are a Linux user, ensure you have Python 3.10 or later installed.
• Run the following command to install Shell-AI via pip:

pip install shell-ai

• Once installation is complete, you can invoke the utility using the shai command.

Usage

Using Shell-AI is as simple as talking to a friend. Here’s how:

• Open your terminal. 
• Type a command like:

shai run terraform dry run thingy

• Upon pressing enter, Shell-AI will present you with suggestions to fulfill your request. For example:
• terraform plan
• terraform plan -input=false
• terraform plan

Features

Shell-AI boasts a range of features that enhance your command-line experience:

• Natural Language Input: You can describe your intentions in plain English.
• Command Suggestions: Get precise command suggestions that accomplish your needs.
• Cross-Platform Compatibility: Works seamlessly on Linux, macOS, and Windows.
• Azure Compatibility: Effortlessly integrates with Azure OpenAI deployments.

Configuration

To harness Shell-AI fully, you may want to configure environment variables. Here’s how:

Environment Variables

You’ll need to set the following environment variable:

• OPENAI_API_KEY: Required. Your OpenAI API key, which you can find on your OpenAI Dashboard.

Optional environment variables include:

• OPENAI_MODEL: Defaults to gpt-3.5-turbo.
• OPENAI_MAX_TOKENS: Limits the tokens generated in chat completion.
• SHAI_SUGGESTION_COUNT: Specify the number of suggestions.
• CTX: Allows the assistant to retain console outputs for better suggestions.

Configuration File

You can also create a JSON configuration file for easier management. Here’s a sample:

{
  "OPENAI_API_KEY": "your_openai_api_key_here",
  "OPENAI_MODEL": "gpt-3.5-turbo",
  "SHAI_SUGGESTION_COUNT": 3,
  "CTX": true
}

Remember to secure the config file appropriately!

Troubleshooting

If you encounter any issues, here are some troubleshooting ideas:

• Ensure that the Python version is compatible.
• Check if you have correctly set up your OPENAI_API_KEY.
• Confirm that Shell-AI is installed by running pip show shell-ai.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

Using Shell-AI simplifies your command line experience by allowing the power of natural language processing to suggest commands tailored to your needs. With a few straightforward configurations, you can elevate your CLI workflow significantly!

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.