Skip to content
/ aia Public

A smart CLI tool powered by OpenAI to assist with terminal commands, answer questions, and provide context-aware help. Automatically detects your working directory and supports piped input. Streamline your workflow with AI! πŸš€βœ¨

License

Notifications You must be signed in to change notification settings

Antosser/aia

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

20 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

AIA Terminal Assistant πŸš€

AIA (AI Assistant) is a terminal-based tool that leverages OpenAI's GPT models to assist you with command-line tasks, answer questions, and provide context-aware assistance based on your current working directory and piped input. πŸ€–πŸ’»

output.mp4

Features ✨

  • Context Awareness: AIA automatically detects the files in your current directory and uses this information to provide relevant assistance. πŸ“‚πŸ”
  • Interactive CLI: Engage in a conversational interface to execute commands, ask follow-up questions, or quit the session. πŸ’¬πŸ”„
  • Piped Input Support: Pass input directly to AIA via pipes (e.g., cat file.txt | aia). πŸ“₯πŸ”—
  • Customizable Configuration: Set your OpenAI API key and preferred model in the configuration file. βš™οΈπŸ”‘

Installation πŸ“₯

To install AIA, follow these steps:

  1. Clone the repository:

    git clone https://github.com/yourusername/aia.git
    cd aia
  2. Build and install the project using Cargo:

    cargo install --path .

This will compile the project and install the aia binary on your system. πŸ› οΈβœ…


Configuration βš™οΈ

Before using AIA, you need to set up your OpenAI API key:

  1. Create a configuration file at ~/.config/aia/config.toml.
  2. Add your OpenAI API key and preferred model to the file:
    openai_token = "your_openai_api_key_here"
    openai_model = "gpt-4"  # or any other supported model

Usage πŸš€

Run AIA in your terminal:

aia

You can also pass input directly via pipes:

cat file.txt | aia

Interactive Commands πŸ•ΉοΈ

  • Input: Type your query or command request. ⌨️
  • Execute Command: AIA will suggest commands, and you can choose to execute them, ask follow-up questions, or quit. πŸ› οΈ
  • Follow-up: Continue the conversation or refine your request. πŸ”„
  • Quit: Exit the AIA session. πŸ›‘

Contributing 🀝

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes. πŸ›πŸ”§


License πŸ“œ

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


Enjoy using AIA to streamline your terminal workflow! 🎯✨

About

A smart CLI tool powered by OpenAI to assist with terminal commands, answer questions, and provide context-aware help. Automatically detects your working directory and supports piped input. Streamline your workflow with AI! πŸš€βœ¨

Topics

Resources

License

Stars

Watchers

Forks

Languages