aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsigoden <sigoden@gmail.com>2025-02-24 07:53:13 +0800
committerGitHub <noreply@github.com>2025-02-24 07:53:13 +0800
commit5cd7e71a13b64661bff32a4f0166dcfdef07993d (patch)
treeff7807fcdd05fc4b4c3b92ed76d5493382fdfb34 /README.md
parent4780ecb39d73a3772d797dba5bfcc18aeb86078a (diff)
downloadllm-functions-docker-5cd7e71a13b64661bff32a4f0166dcfdef07993d.tar.gz
refactor: rename `argc install` to `argc link-to-aichat` (#171)
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index d885258..c8424c6 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,7 @@ Make sure you have the following tools installed:
```sh
git clone https://github.com/sigoden/llm-functions
+cd llm-functions
```
### 2. Build tools and agents
@@ -82,14 +83,22 @@ argc build
argc check
```
-### 3. Install to AIChat
+### 3. Link LLM-functions and AIChat
-Symlink this repo directory to AIChat's **functions_dir**:
+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.
+
+You can symlink this repository directory to AIChat's **functions_dir** with:
```sh
ln -s "$(pwd)" "$(aichat --info | sed -n 's/^functions_dir\s\+//p')"
# OR
-argc install
+argc link-to-aichat
+```
+
+Alternatively, you can tell AIChat where the LLM-functions directory is by using an environment variable:
+
+```sh
+export AICHAT_FUNCTIONS_DIR="$(pwd)"
```
### 4. Start using the functions