Ecosyste.ms: Awesome

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

https://github.com/iivvoo/clai

Command Line AI
https://github.com/iivvoo/clai

Last synced: about 1 month ago
JSON representation

Command Line AI

Lists

README 

        
# CLAI - Command Line AI



`clai` is a command line integration for openai. It's setup to help you learn

new shell commands and construct more complex commands. E.g.



    $ clai "group a tab separated file by first column, sum them by third column"

    awk -F'\t' '{sum[$1] += $3} END {for(group in sum) print group, sum[group]}' file.txt



    This command uses awk to read a tab-separated file, it creates an array 'sum' where the keys are the values in the first column and the values are the sum of the third column for each group. Finally, it prints the group and the sum.



and



    $ clai "find the largest file"

    To find the largest file in a directory and its subdirectories, you can use the `find` and `du` commands together:



    ```bash

    find /path/to/directory -type f -exec du -sh {} + | sort -rh | head -n 1

    ```



    This command will find all the files in the specified directory and its subdirectories, calculate their sizes using `du`, sort them in descending order, and display the largest file with its size.



By default it assumes a gnu / linux / bash environment, but by explicitly mentioning, e.g. macos or powershell you can get

it to provide solutions for other environments.



    C:\> clai.exe "find the largest file using powershell"

    To find the largest file using PowerShell, you can use the following command:



    ```powershell

    Get-ChildItem -File | Sort-Object -Property Length -Descending | Select-Object -First 1

    ```



    This command uses the `Get-ChildItem` cmdlet to list all files in the current directory, piped to `Sort-Object` to sort them by file size in descending order, and then piped to `Select-Object` to select just the first (largest) file.



## Install



```

$ git clone https://github.com/iivvoo/clai.git

$ make

```



Your binary will be in `bin/clai`



Releases for several architectures including linux, macos and windows are available on the [Releases](https://github.com/iivvoo/clai/releases) page.



## Prerequisites and configuration



You will need an OpenAI api key. Open https://platform.openai.com/account/api-keys to create a key, create an

account if necessary. New users get some free credit but at some point you will need to pay for API access.

The (default) GPT3Dot5Turbo model should work really well and is very price efficient.



Configuration is done through a config.yml file that can be placed in $HOME/.clai/ or $HOME/.config/clai/



Here you can also tweak the system prompt (make it more suitable to your needs or environment) and disable the disclaimer once you  get fed up with it and are aware that you should always double check anything generated or suggested by an AI



Alternatively you can just set the `OPENAI_APIKEY` or `CLAI_APIKEY` environment variable with your key and run on defaults.



You can run `clai defaults` to see the known models and the default system prompt.



## License



clai is open source and available under the MIT License. See LICENSE.txt