spmfte / ai-assistant

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AI-Assistant

AI-Assistant is a command-line tool designed to integrate with the LocalAI API. It offers a text-based interface for AI-driven conversation and code completion features.

Features

  • TUI Interface: Simplified interaction with the LocalAI API through a text interface.
  • Chat Mode: Retrieve AI-generated conversational responses.
  • Completion Mode: Access AI-enhanced code completions.
  • Autostart LocalAI: Automatic startup without the need for manual server interactions.

Usage

To initiate the AI-Assistant:

./ai-assistant

Navigation:

  • Use arrow keys, j, and k for navigation.
  • Select options with the Enter key.

Available Options:

  • Chat: Engage in an AI-generated conversation.
  • Completion: Receive code suggestions.
  • Exit: Terminate the application and the associated LocalAI server.

Development

To further develop or customize AI-Assistant:

  1. Clone the repository:
git clone https://github.com/yourusername/ai-assistant.git
  1. Adhere to Go's development standards for an optimal development experience. Contributions in the form of PRs and issues are always welcome.

Contribution Process

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/NewFeature).
  3. Commit your changes (git commit -m 'Add NewFeature').
  4. Push the branch (git push origin feature/NewFeature).
  5. Submit a pull request.

License

AI-Assistant is licensed under the MIT License. Refer to the LICENSE file for more details.

Acknowledgments

  • LocalAI for their on-premise AI solutions.
  • OpenAI for their advancements in AI technology.

Feedback and issues are appreciated. Feel free to customize as needed.

About

License:MIT License


Languages

Language:Go 100.0%