Skip to content

Commit

Permalink
Update and extend the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ad-si committed Apr 13, 2024
1 parent 21cd738 commit 2d54718
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 12 deletions.
53 changes: 41 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
# `cai` - The fastest CLI tool for prompting LLMs

- Prompt the best AIs directly from the terminal and faster than ever before! ⚡️
- Finishing often in **less than 1 second**. 🚀
- Build with Rust 🦀 and [Groq] for supreme performance and speed! 🏎️

## Features

- Build with Rust 🦀 for supreme performance and speed! 🏎️
- Support for models by [Groq], [OpenAI], [Anthropic], and local LLMs. 📚
- Prompt several models at once. 🤼
![Demo of cai's all command](screenshots/2024-04-13t1627_all.png)
- Syntax highlighting for better readability of code snippets. 🌈

[Groq]: https://console.groq.com/docs/models
[OpenAI]: https://platform.openai.com/docs/models
[Anthropic]: https://docs.anthropic.com/claude/docs/models-overview


## Demo

![`cai` demo](./demos/main.gif)

Expand All @@ -21,16 +33,24 @@ Simply execute `cai` in your terminal and follow the instructions.

Cai supports the following APIs:

- **Groq** (mixtral-8x7b-32768) -
[Create new API key here](https://console.groq.com/keys).
- **OpenAI** (gpt-4-turbo-preview) -
[Create new API key here](https://platform.openai.com/api-keys).
- **localhost:8080** - No API key required.
- **Groq** - [Create new API key](https://console.groq.com/keys).
- **OpenAI** - [Create new API key](https://platform.openai.com/api-keys).
- **Anthropic** -
[Create new API key](https://console.anthropic.com/settings/keys).
- **localhost:8080** - Any OpenAI API compatible local server (E.g. [llamafile])

[llamafile]: https://github.com/Mozilla-Ocho/llamafile

Afterwards, you can use `cai` to run prompts directly from the terminal:

```bash
cai list fast CLI tools
```sh
cai List 10 fast CLI tools
```

Or a specific model, like Anthropic's Claude Opus:

```sh
cai op List 10 fast CLI tools
```

For more information, run:
Expand All @@ -39,6 +59,15 @@ For more information, run:
cai help
```

---

### Follow [@AdrianSieber](https://x.com/AdrianSieber) for more! 🚀
## Related

- [AIChat] - All-in-one chat and copilot CLI for 10+ AI platforms. (Rust)
- [ja] - CLI / TUI app to work with AI tools. (Rust)
- [llm] - Access large language models from the command-line. (Python)
- [smartcat] - Integrate LLMs in the Unix command ecosystem. (Rust)

[AIChat]: https://github.com/sigoden/aichat
[ja]: https://github.com/joshka/ja
[llm]: https://github.com/simonw/llm
[smartcat]: https://github.com/efugier/smartcat
Binary file added screenshots/2024-04-13t1627_all.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2d54718

Please sign in to comment.