diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 27 insertions, 22 deletions
@@ -22,20 +22,23 @@ Make sure you have the following tools installed: - [argc](https://github.com/sigoden/argc): A bash command-line framework and command runner - [jq](https://github.com/jqlang/jq): A JSON processor -## Getting Started with [AIChat](https://github.com/sigoden/aichat) +## Installation -**Currently, AIChat is the only CLI tool that supports `llm-functions`. We look forward to more tools supporting `llm-functions`.** +1. Clone this repository: -### 1. Clone the repository +```bash +git clone https://git.kug.is/llm-functions-docker.git +``` -```sh -git clone https://github.com/sigoden/llm-functions -cd llm-functions +2. `cd` into the project directory: + +```bash +cd llm-functions-docker ``` -### 2. Build tools and agents +3. Build tools and agents. You can either build all at once or a selection of tools manually. -#### Build all tools using make +### Build all tools with GNU-Make Simply build all tools using GNU-Make: @@ -43,9 +46,9 @@ Simply build all tools using GNU-Make: make ``` -#### Build individual tools +### Build selection of tools -##### I. Create a `./tools.txt` file with each tool filename on a new line. +#### Create a `./tools.txt` file with each tool filename on a new line. ``` get_current_weather.sh @@ -79,26 +82,28 @@ Now there is a `web_search.sh` ready to be added to your `./tools.txt`. </details> -##### II. Create a `./agents.txt` file with each agent name on a new line. +#### Create a `./agents.txt` file with each agent name on a new line. ``` coder todo ``` -##### III. Build `bin` and `functions.json` +#### Build `bin` and `functions.json` ```sh argc build ``` -##### IV. Ensure that everything is ready (environment variables, Node/Python dependencies, mcp-bridge server) +#### Ensure that everything is ready (environment variables, Node/Python dependencies, mcp-bridge server) ```sh argc check ``` -### 3. Link LLM-functions and AIChat +## Usage + +### Link LLM-functions and AIChat AIChat expects LLM-functions to be placed in AIChat's **functions_dir** so that AIChat can use the tools and agents that LLM-functions provides. @@ -116,7 +121,7 @@ Alternatively, you can tell AIChat where the LLM-functions directory is by using export AICHAT_FUNCTIONS_DIR="$(pwd)" ``` -### 4. Start using the functions +### Start using the functions Done! Now you can use the tools and agents with AIChat. @@ -212,19 +217,19 @@ documents: - https://example.com/remote-file.txt ``` -Refer to [./agents/demo](https://github.com/sigoden/llm-functions/tree/main/agents/demo) for examples of how to implement a agent. +Refer to [./agents/demo](agents/demo) for examples of how to implement a agent. ## MCP (Model Context Protocol) -- [mcp/server](https://github.com/sigoden/llm-functions/tree/main/mcp/server): Let LLM-Functions tools/agents be used through the Model Context Protocol. -- [mcp/bridge](https://github.com/sigoden/llm-functions/tree/main/mcp/bridge): Let external MCP tools be used by LLM-Functions. +- [mcp/server](mcp/server): Let LLM-Functions tools/agents be used through the Model Context Protocol. +- [mcp/bridge](mcp/bridge): Let external MCP tools be used by LLM-Functions. ## Documents -- [Tool Guide](https://github.com/sigoden/llm-functions/blob/main/docs/tool.md) -- [Agent Guide](https://github.com/sigoden/llm-functions/blob/main/docs/agent.md) -- [Argc Commands](https://github.com/sigoden/llm-functions/blob/main/docs/argcfile.md) +- [Tool Guide](docs/tool.md) +- [Agent Guide](docs/agent.md) +- [Argc Commands](docs/argcfile.md) ## License -The project is under the MIT License, Refer to the [LICENSE](https://github.com/sigoden/llm-functions/blob/main/LICENSE) file for detailed information. +The project is under the MIT License, Refer to the [LICENSE](LICENSE) file for detailed information. |