Skip to content

Commit 5cd7e71

Browse files
authored
refactor: rename argc install to argc link-to-aichat (#171)
1 parent 4780ecb commit 5cd7e71

File tree

3 files changed

+16
-7
lines changed

3 files changed

+16
-7
lines changed

Argcfile.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -549,8 +549,8 @@ link-code-interpreter() {
549549
_link_tool $1 code_interpreter
550550
}
551551

552-
# @cmd Install this repo to aichat functions_dir
553-
install() {
552+
# @cmd Link this repo to aichat functions_dir
553+
link-to-aichat() {
554554
functions_dir="$(aichat --info | grep -w functions_dir | awk '{$1=""; print substr($0,2)}')"
555555
if [[ -z "$functions_dir" ]]; then
556556
_die "error: your aichat version don't support function calling"

README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Make sure you have the following tools installed:
2525

2626
```sh
2727
git clone https://github.com/sigoden/llm-functions
28+
cd llm-functions
2829
```
2930

3031
### 2. Build tools and agents
@@ -82,14 +83,22 @@ argc build
8283
argc check
8384
```
8485

85-
### 3. Install to AIChat
86+
### 3. Link LLM-functions and AIChat
8687

87-
Symlink this repo directory to AIChat's **functions_dir**:
88+
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.
89+
90+
You can symlink this repository directory to AIChat's **functions_dir** with:
8891

8992
```sh
9093
ln -s "$(pwd)" "$(aichat --info | sed -n 's/^functions_dir\s\+//p')"
9194
# OR
92-
argc install
95+
argc link-to-aichat
96+
```
97+
98+
Alternatively, you can tell AIChat where the LLM-functions directory is by using an environment variable:
99+
100+
```sh
101+
export AICHAT_FUNCTIONS_DIR="$(pwd)"
93102
```
94103

95104
### 4. Start using the functions

docs/argcfile.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ argc link-web-search web_search_tavily.sh
7070
argc link-code-interpreter execute_py_code.py
7171

7272
# -------- Misc --------
73-
# Install this repo to aichat functions_dir
74-
argc install
73+
# Link this repo to aichat functions_dir
74+
argc link-to-aichat
7575
# Displays version information for required tools
7676
argc version
7777
```

0 commit comments

Comments
 (0)