summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsigoden <sigoden@gmail.com>2024-10-24 17:47:25 +0800
committersigoden <sigoden@gmail.com>2024-10-24 17:47:25 +0800
commit04a0024b8348a60ed160827511d531015b5f0442 (patch)
tree012d98df9c1d5d773d23ad06890b35d267c22b67 /README.md
parentb05d14a7c004cb570e012361ad680cdf9c4d62a9 (diff)
downloadaichat-04a0024b8348a60ed160827511d531015b5f0442.tar.gz
chore: update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 12 insertions, 19 deletions
diff --git a/README.md b/README.md
index 13744b5..62b9600 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# AIChat: All-in-one AI CLI Tool
+# AIChat: All-in-one LLM CLI Tool
[![CI](https://github.com/sigoden/aichat/actions/workflows/ci.yaml/badge.svg)](https://github.com/sigoden/aichat/actions/workflows/ci.yaml)
[![Crates](https://img.shields.io/crates/v/aichat.svg)](https://crates.io/crates/aichat)
@@ -24,7 +24,7 @@ Download pre-built binaries for macOS, Linux, and Windows from [GitHub Releases]
### Multi-Platform Support
-Seamlessly integrate with over 20 leading LLM platforms via a unified interface, including OpenAI, Azure-OpenAI, Gemini (Google AI Studio), VertexAI, Claude, Ollama, Groq, VertexAI, Bedrock, Mistral, AI21, Grok, Cohere, Perplexity, Cloudflare, OpenRouter, Ernie, Qianwen, Moonshot, Deepseek, ZhipuAI, Yi, Jina, VoyageAI, and any OpenAI-Compatible platforms.
+Seamlessly integrate with over 20 leading LLM platforms via a unified interface, including OpenAI, Claude, Gemini (Google AI Studio), Ollama, Groq, Azure-OpenAI, VertexAI, Bedrock, Huggingface, Github Models, Mistral, Deepseek, AI21, XAI Grok, Cohere, Perplexity, Cloudflare, OpenRouter, Ernie, Qianwen, Moonshot, ZhipuAI, Lingyiwanwu, Deepinfra, Fireworks, Siliconflow, Together, Jina, VoyageAI, and any OpenAI-Compatible platforms.
### Shell Assistant
@@ -44,26 +44,21 @@ Bring a powerful Chat-REPL with features such as tab autocompletion, multi-line
Accept various forms of input, such as stdin, local files & dirs, and remote URLs.
-```sh
-# Use stdin
-cat data.txt | aichat
-# Use local file
-aichat -f data.txt
-# Use image file
-aichat -f image.png ocr
-# Use multi files
-aichat -f file1 -f file2 explain
-# Use local dirs
-aichat -f dir/ summarize
-# Use remote URLs
-aichat -f https://example.com/page summarize
-```
+| Input | Example |
+| ----------------- | ------------------------------------ |
+| CMD input | `aichat hello` |
+| Stdin pipe | `cat data.txt \| aichat` |
+| Local files | `aichat -f data.txt` |
+| Local images | `aichat -f image.png` |
+| Local directories | `aichat -f dir/` |
+| Remote URLs | `aichat -f https://example.com` |
+| Combine Inputs | `aichat -f dir/ -f data.txt explain` |
### Role
Define custom roles to tailor LLM behaviors, enhancing interactions and boosting productivity.
-![aichat-role](https://github.com/user-attachments/assets/9e0bb48b-20aa-4ab0-8bff-9306dc1c44a2)
+![aichat-role](https://github.com/user-attachments/assets/023df6d2-409c-40bd-ac93-4174fd72f030)
> The role consists of a prompt and model configuration.
@@ -82,8 +77,6 @@ Integrate external documents into your LLM conversations for more accurate and c
![aichat-rag](https://github.com/user-attachments/assets/359f0cb8-ee37-432f-a89f-96a2ebab01f6)
-> Supports local files and directories, as well as remote URLs, including entry websites.
-
### Function Calling
Function calling supercharges LLMs by connecting them to external tools and data sources. This unlocks a world of possibilities, enabling LLMs to go beyond their core capabilities and tackle a wider range of tasks.