Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apockill/clai

Command Line AI- this tool lets you call ChatGPT from any textbox on your computer
https://github.com/apockill/clai

Last synced: 3 months ago
JSON representation

Command Line AI- this tool lets you call ChatGPT from any textbox on your computer

Host: GitHub
URL: https://github.com/apockill/clai
Owner: apockill
Created: 2023-03-05T21:19:44.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-03-15T20:07:10.000Z (over 1 year ago)
Last Synced: 2024-07-17T09:07:18.773Z (4 months ago)
Language: Python
Homepage:
Size: 146 KB
Stars: 11
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # 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.

_________________

[![PyPI version](https://badge.fury.io/py/clai.svg)](http://badge.fury.io/py/clai)

[![Test Status](https://github.com/apockill/clai/workflows/Test/badge.svg?branch=main)](https://github.com/apockill/clai/actions?query=workflow%3ATest)

[![Lint Status](https://github.com/apockill/clai/workflows/Lint/badge.svg?branch=main)](https://github.com/apockill/clai/actions?query=workflow%3ALint)

[![codecov](https://codecov.io/gh/apockill/clai/branch/main/graph/badge.svg)](https://codecov.io/gh/apockill/clai)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](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 python3-tk python3-dev

   ```

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=

   ```

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 `. 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/tree/feature/arbitrary-commands