# clai
Command Line AI- this tool lets you call ChatGPT from a CLI.
I'm designing this to be used in conjunction with a fork of [shin][shin], which will allow you
to call `clai` from any textbox in your computer. Finally, ChatGPT everywhere!
The long-term vision for this project is to add support for extracting context. For example, it would
read the current text on a window and be able to add to it, or answer questions about it.
_________________
[](http://badge.fury.io/py/clai)
[](https://github.com/apockill/clai/actions?query=workflow%3ATest)
[](https://github.com/apockill/clai/actions?query=workflow%3ALint)
[](https://codecov.io/gh/apockill/clai)
[](https://github.com/psf/black)
[](https://timothycrosley.github.io/isort/)
_________________
[Read Latest Documentation](https://apockill.github.io/clai/) - [Browse GitHub Code Repository](https://github.com/apockill/clai/)
_________________
## Installation
1. The recommended installation method is to use `pipx`, via
```bash
pipx install clai
```
Optionally, install `tesseract` so that `clai` can read the screen context and send that along with requests:
```bash
sudo apt install tesseract-ocr scrot
```
1. Then go to [OpenAI] and create an API Key. Once it's generated, add the following to
your `~/.profile`:
```bash
export OPENAI_API_TOKEN=<paste here>
```
1. The best way to use this tool is in conjunction with the tool [shin][shin], which allows you
to run arbitrary bash commands in any textbox in a linux computer, using ibus. To use
that, install 'shin' via the fork above, then configure
it in your `~/.profile` to call `clai` by default:
```bash
export SHIN_DEFAULT_COMMAND="clai"
```
1. Log out then log back in for the changes to take effect!
[OpenAI]: https://platform.openai.com/account/api-keys
## Usage
Invoke the assistant with the format `clai <your prompt>`. For example:
```
clai Write an email saying I'll be late to work because I'm working on commandline AIs
```
## Development
### Installing python dependencies
```shell
poetry install
```
### Running Tests
```shell
pytest .
```
### Formatting Code
```shell
bash .github/format.sh
```
### Linting
```shell
bash .github/check_lint.sh
```
[shin]: https://github.com/apockill/shin
