{"id":13620991,"url":"https://github.com/micheam/ai-assistant-console","last_synced_at":"2025-04-11T02:06:55.229Z","repository":{"id":187728601,"uuid":"634707665","full_name":"micheam/ai-assistant-console","owner":"micheam","description":"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.","archived":false,"fork":false,"pushed_at":"2025-03-11T01:09:55.000Z","size":1229,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T02:06:06.880Z","etag":null,"topics":["ai","ai-assistant","cli-app","command-line-tool","gpt","vim-plugin","vim-plugins","vim9script"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/micheam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-05-01T01:09:35.000Z","updated_at":"2025-02-18T03:11:59.000Z","dependencies_parsed_at":"2024-01-14T16:58:16.904Z","dependency_job_id":"afb91ef1-b81f-4588-bb8d-3071b8fb857d","html_url":"https://github.com/micheam/ai-assistant-console","commit_stats":null,"previous_names":["micheam/ai-assistant-console"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheam%2Fai-assistant-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheam%2Fai-assistant-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheam%2Fai-assistant-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheam%2Fai-assistant-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/micheam","download_url":"https://codeload.github.com/micheam/ai-assistant-console/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248328167,"owners_count":21085261,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ai-assistant","cli-app","command-line-tool","gpt","vim-plugin","vim-plugins","vim9script"],"created_at":"2024-08-01T21:01:01.503Z","updated_at":"2025-04-11T02:06:55.206Z","avatar_url":"https://github.com/micheam.png","language":"Go","funding_links":[],"categories":["Go","Conversation-focused"],"sub_categories":[],"readme":"\u003e [!WARNING]\n\u003e This project is still in development and is not ready for use.\n\n# AICO - AI Assistant Console\n[![Go](https://github.com/micheam/ai-assistant-console/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/micheam/ai-assistant-console/actions/workflows/go.yml)\n\n![screenshot](screenshot.png)\n\nAICO is an AI-powered text generation tool using OpenAI's GPT-4 and other supported models.\n\n## Install\n\nSince pre-built binaries are not provided, you will need to install Go to build and run AICO.\nMake sure you have _Go version 1.20 or higher_ installed on your system. \nYou can check the installed version by running `go version`.\n\nIf you do not have Go installed or your version is outdated, download and install it from the [Go website](https://golang.org/dl/).\n\nOnce you have Go installed, follow these steps to install AICO:\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/micheam/ai-assistant-console.git\n   ```\n2. Navigate to the project directory:\n   ```bash\n   cd ai-assistant-console\n   ```\n3. Use the `go.mod` file to manage dependencies. You don't need to do anything manually since Go will handle this for you.\n4. Build the executable binary by running `make`:\n   ```bash\n   make\n   ```\n   This will create a binary executable in the `bin/` directory.\n\nNow, you can use commands as described in the [Usage](#usage) section.\n\n## OpenAI API Key\n\nCurrently, AICO requires an OpenAI API key to use the GPT-4 API.\nYou can get an API key from [the OpenAI API Keys page].\n\nOnce you have an API key, you can set it in the `OPENAI_API_KEY` environment variable:\n\n```bash\nexport OPENAI_API_KEY=\u003cyour API key\u003e\n```\n\n## Usage of the `chat` Command\n\nAfter building the binary, you can run `chat` to start chatting with AI.\n\n```\nNAME:\n   chat - Chat with AI\n\nUSAGE:\n   chat [global options] command [command options] [arguments...]\n\nVERSION:\n   0.0.11\n\n\nCOMMANDS:\n   config   Show config file path\n   tui      Chat with AI in TUI\n   send     Send message to AI\n   help, h  Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n   --debug                    Enable debug mode (default: false) [$AICO_DEBUG]\n   --model value, -m value    GPT model to use (default: \"gpt-4\")\n   --persona value, -p value  Persona to use (default: \"default\")\n   --help, -h                 show help\n   --version, -v              print the version\n```\n\n### TUI Mode\n\nTo chat with AI in TUI mode, use the `tui` subcommand:\n\n```bash\n$ ./bin/chat tui\n```\n\nIn TUI mode, you can send message with ';; (double semicolon)' line.\n\n```bash\n$ ./bin/chat tui\nConversation with gpt-4-1106-preview\n------------------------------\n\u003e Translate into English:\n\u003e \n\u003e こんにちは、世界。\n\u003e ;;\n\nHello, world.\n```\n\nYou can input Image URL to get the description of the image.\n(with `chatgpt-4o-latest` model)\n\n```bash\n$ chat --model=chatgpt-4o-latest tui\nConversation with chatgpt-4o-latest\n------------------------------\n\u003e What is in this image?\n\u003e \n\u003e \u003chttps://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg\u003e\n\u003e ;;\n\nThis image shows a serene natural landscape with a wooden boardwalk path extending through a lush green\n field. The sky is bright and blue with scattered clouds, creating a peaceful and vibrant outdoor scene.\n Trees and bushes are visible in the background, adding to the natural beauty of the setting.\n```\n\n### Batch Mode\n\nTo send a message to AI, use the `send` subcommand:\n\n```bash\n$ ./bin/chat send \"Translate into English: こんにちは、世界。\"\nHello, world.\n```\n\n## Usage as a Vim Plugin\n\nAICO can be used as a Vim plugin to generate text in Vim buffers.\nPlease see the [Vim plugin documentation](README.vim.md) for more information.\n\n## Environment Variables\n\n- `AICO_DEBUG`: Sets the debug mode of AICO. Default is `false`.\n\n## Development\n\nTo contribute to AICO development, clone this repository and make the desired code changes.\nBefore submitting your changes, ensure the following:\n\n- All tests pass by running `make test`\n- The code formatting is consistent and adheres to [Go standards](https://golang.org/doc/effective_go)\n\n## License\nThe AICO project is released under the [MIT License](LICENSE).\n\n\n[the OpenAI API Keys page]: https://platform.openai.com/api-keys\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicheam%2Fai-assistant-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicheam%2Fai-assistant-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicheam%2Fai-assistant-console/lists"}