diff options
| author | sigoden <sigoden@gmail.com> | 2024-12-10 12:05:58 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-12-10 12:05:58 +0800 |
| commit | 6dbc32836a46d16ceace198883a28e5d311b94a5 (patch) | |
| tree | 3a0652c43e0a75aa55bfdf44b0f061d0a4f5ebbe /README.md | |
| parent | 8ef3562c4254961179100d7eb87037c3f3ae5539 (diff) | |
| download | aichat-6dbc32836a46d16ceace198883a28e5d311b94a5.tar.gz | |
chore: release v0.25.0 (#1045)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 57 |
1 files changed, 30 insertions, 27 deletions
@@ -4,7 +4,7 @@ [](https://crates.io/crates/aichat) [](https://discord.gg/mr3ZZUB9hG) -AIChat is an all-in-one LLM CLI tool featuring Chat-REPL, Shell Assistant, RAG, AI Tools & Agents, and More. +AIChat is an all-in-one LLM CLI tool featuring Shell Assistant, CMD & REPL Mode, RAG, AI Tools & Agents, and More. ## Install @@ -22,47 +22,50 @@ Download pre-built binaries for macOS, Linux, and Windows from [GitHub Releases] ## Features -### Multi-Platform Support +### Multi-Platform Compatibility -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. +Integrate seamlessly with over 20 leading LLM platforms through a unified interface. Supported platforms include 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, any OpenAI-Compatible platforms. -### Chat-REPL +### CMD Mode -Bring a powerful Chat-REPL with features such as tab autocompletion, multi-line support, history search, configurable keybindings, and custom REPL prompt. +Explore powerful command-line functionalities with AIChat's CMD mode. + + + +### REPL Mode + +Experience an interactive Chat-REPL with features like tab autocompletion, multi-line input support, history search, configurable keybindings, and custom REPL prompts.  ### Shell Assistant -Supercharge your command line experience. Simply describe your desired actions in natural language, and let AIChat translate your requests into precise shell commands. +Elevate your command-line efficiency. Describe your tasks in natural language, and let AIChat transform them into precise shell commands. AIChat intelligently adjusts to your OS and shell environment.  -**OS-Aware Intelligence:** AIChat tailors commands to your specific operating system and shell environment. - ### Multi-Form Input -Accept various forms of input, such as stdin, local files & dirs, and remote URLs. +Accept diverse input forms such as stdin, local files and directories, and remote URLs, allowing flexibility in data handling. -| 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` | +| Input | CMD | REPL | +| ----------------- | ------------------------------------ | -------------------------------- | +| CMD | `aichat hello` | | +| STDIN | `cat data.txt \| aichat` | | +| Local files | `aichat -f image.png -f data.txt` | `.file image.png data.txt` | +| Local directories | `aichat -f dir/` | `.file dir/` | +| Remote URLs | `aichat -f https://example.com` | `.file https://example.com` | +| Combine Inputs | `aichat -f dir/ -f data.txt explain` | `.file dir/ data.txt -- explain` | -### Role +### Role Management -Define custom roles to tailor LLM behaviors, enhancing interactions and boosting productivity. +Customize roles to tailor LLM behavior, enhancing interaction efficiency and boosting productivity.  > The role consists of a prompt and model configuration. -### Session +### Session Management Maintain context-aware conversations through sessions, ensuring continuity in interactions. @@ -95,9 +98,9 @@ AI Agent = Instructions (Prompt) + Tools (Function Callings) + Documents (RAG).  -### Local Server +### Local Server Capabilities -AIChat comes with a built-in lightweight http server. +AIChat includes a lightweight built-in HTTP server for easy deployment. ``` $ aichat --serve @@ -110,7 +113,7 @@ LLM Arena: http://127.0.0.1:8000/arena?num=2 #### Proxy LLM APIs -AIChat offers the ability to function as a proxy server for all LLMs. This allows you to interact with different LLMs using the familiar OpenAI API format, simplifying the process of accessing and utilizing these LLMs. +The LLM Arena is a web-based platform where you can compare different LLMs side-by-side. Test with curl: @@ -124,13 +127,13 @@ curl -X POST -H "Content-Type: application/json" -d '{ #### LLM Playground -The LLM Playground is a webapp that allows you to interact with any LLM supported by AIChat directly in your browser. +A web application to interact with supported LLMs directly from your browser. - + #### LLM Arena -The LLM Arena is a web-based platform where you can compare different LLMs side-by-side. +A web platform to compare different LLMs side-by-side.  |