Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micheam/ai-assistant-console
An intuitive CLI client and Vim9 plugin for the OpenAI API, enabling seamless AI-powered text generation directly from your command line or within Vim. Simple to use, yet powerful.
https://github.com/micheam/ai-assistant-console
ai ai-assistant cli-app command-line-tool gpt vim-plugin vim-plugins vim9script
Last synced: 9 days ago
JSON representation
An intuitive CLI client and Vim9 plugin for the OpenAI API, enabling seamless AI-powered text generation directly from your command line or within Vim. Simple to use, yet powerful.
- Host: GitHub
- URL: https://github.com/micheam/ai-assistant-console
- Owner: micheam
- Created: 2023-05-01T01:09:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-03T17:47:44.000Z (3 months ago)
- Last Synced: 2024-08-03T19:00:33.250Z (3 months ago)
- Topics: ai, ai-assistant, cli-app, command-line-tool, gpt, vim-plugin, vim-plugins, vim9script
- Language: Go
- Homepage:
- Size: 170 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- project-awesome - micheam/ai-assistant-console - An intuitive CLI client and Vim9 plugin for the OpenAI API, enabling seamless AI-powered text generation directly from your command line or within Vim. Simple to use, yet powerful. (Go)
- awesome-vim-llm-plugins - micheam/ai-assistant-console
README
> [!WARNING]
> This project is still in development and is not ready for use.
# AICO - AI Assistant Console
AICO is an AI-powered text generation tool using OpenAI's GPT-4.
## Install
Since pre-built binaries are not provided, you will need to install Go to build and run AICO.
Make sure you have _Go version 1.20 or higher_ installed on your system.
You can check the installed version by running `go version`.
If you do not have Go installed or your version is outdated, download and install it from the [Go website](https://golang.org/dl/).
Once you have Go installed, follow these steps to install AICO:
1. Clone the repository:
```bash
git clone https://github.com/micheam/ai-assistant-console.git
```
2. Navigate to the project directory:
```bash
cd ai-assistant-console
```
3. Use the `go.mod` file to manage dependencies. You don't need to do anything manually since Go will handle this for you.
4. Build the executable binary by running `make`:
```bash
make
```
This will create a binary executable in the `bin/` directory.
Now, you can use commands as described in the [Usage](#usage) section.
## OpenAI API Key
Currently, AICO requires an OpenAI API key to use the GPT-4 API.
You can get an API key from [the OpenAI API Keys page].
Once you have an API key, you can set it in the `OPENAI_API_KEY` environment variable:
```bash
export OPENAI_API_KEY=
```
## Usage of `chat` Command
After building the binary, you can run `chat` to start chatting with AI.
```
NAME:
chat - Chat with AI
USAGE:
chat [global options] command [command options] [arguments...]
VERSION:
0.0.7
COMMANDS:
config Show config file path
tui Chat with AI in TUI
send Send message to AI
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--debug Enable debug mode (default: false) [$AICO_DEBUG]
--model value, -m value GPT model to use (default: "gpt-4")
--persona value, -p value Persona to use (default: "default")
--help, -h show help
--version, -v print the version
```
### TUI Mode
To chat with AI in TUI mode, use the `tui` subcommand:
```bash
$ ./bin/chat tui
```
In TUI mode, you can send message with ';; (double semicolon)' line.
```bash
$ ./bin/chat tui
Conversation with gpt-4-1106-preview
------------------------------
> Translate into English:
>
> こんにちは、世界。
> ;;
Hello, world.
```
### Batch Mode
To send a message to AI, use the `send` subcommand:
```bash
$ ./bin/chat send "Translate into English: こんにちは、世界。"
Hello, world.
```
## Usage as a Vim Plugin
AICO can be used as a Vim plugin to generate text in Vim buffers.
Please see the [Vim plugin documentation](README.vim.md) for more information.
## Environment Variables
- `AICO_DEBUG`: Sets the debug mode of AICO. Default is `false`.
## Development
To contribute to AICO development, clone this repository and make the desired code changes.
Before submitting your changes, ensure the following:
- All tests pass by running `make test`
- The code formatting is consistent and adheres to [Go standards](https://golang.org/doc/effective_go)
## License
The AICO project is released under the [MIT License](LICENSE).
[the OpenAI API Keys page]: https://platform.openai.com/api-keys