chore: optimize readme and rm package-lock.json because we use bun not npm
Browse files- README.md +21 -25
- package-lock.json +0 -0
README.md
CHANGED
|
@@ -11,29 +11,11 @@
|
|
| 11 |
curl -fsSL https://raw.githubusercontent.com/versperai/VersperClaw/main/install.sh | bash
|
| 12 |
|
| 13 |
# source install
|
| 14 |
-
git clone https://github.com/versperai/VersperClaw.git && cd VersperClaw && bun install && bun run build:dev:full && ./VersperClaw
|
| 15 |
-
```
|
| 16 |
-
|
| 17 |
-
```bash
|
| 18 |
-
# make symbol link for everywhere can use VersperClaw just with a
|
| 19 |
-
ln -sf "$(pwd)/VersperClaw" "$HOME/.local/bin/VersperClaw"
|
| 20 |
-
|
| 21 |
-
# overwrite
|
| 22 |
-
cp VersperClaw ~/.local/bin/VersperClaw
|
| 23 |
-
|
| 24 |
-
# make sure `~/.local/bin` in PATH
|
| 25 |
-
# check if have in path
|
| 26 |
-
echo $PATH | grep -q "$HOME/.local/bin" && echo "In PATH" || echo "Out PATH"
|
| 27 |
|
| 28 |
-
# if
|
| 29 |
-
|
| 30 |
-
#
|
| 31 |
-
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
|
| 32 |
-
source ~/.bashrc
|
| 33 |
-
|
| 34 |
-
# for zsh
|
| 35 |
-
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
|
| 36 |
-
source ~/.zshrc
|
| 37 |
```
|
| 38 |
|
| 39 |
## 2. WebSearch & WebFetch Tools - 100% local free no remote api fee
|
|
@@ -46,6 +28,10 @@ source ~/.zshrc
|
|
| 46 |
</tr>
|
| 47 |
</table>
|
| 48 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 49 |
```bash
|
| 50 |
# local config search engine - searxng in archlinux
|
| 51 |
# make sure have install docker and docker-compose
|
|
@@ -57,8 +43,12 @@ sudo usermod -aG docker $USER
|
|
| 57 |
sudo systemctl enable --now docker
|
| 58 |
```
|
| 59 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 60 |
```bash
|
| 61 |
-
# install searxng in docker-compose
|
| 62 |
curl -fsSL \
|
| 63 |
-O https://raw.githubusercontent.com/searxng/searxng/master/container/docker-compose.yml \
|
| 64 |
-O https://raw.githubusercontent.com/searxng/searxng/master/container/.env.example
|
|
@@ -66,11 +56,13 @@ curl -fsSL \
|
|
| 66 |
# add json source in formats behind html - jsonl in 87 lines
|
| 67 |
cd searxng/core-config/ && sudo nvim settings.yml
|
| 68 |
|
| 69 |
-
# or use VersperSearch a pre-build docker config in https://github.com/versperai/VersperSearch
|
| 70 |
-
|
| 71 |
# start searxng engine
|
| 72 |
docker compose up -d
|
|
|
|
| 73 |
|
|
|
|
|
|
|
|
|
|
| 74 |
# check in every browser
|
| 75 |
firefox http://localhost:8080
|
| 76 |
|
|
@@ -85,6 +77,10 @@ firefox http://localhost:8080
|
|
| 85 |
export ENABLE_TOOL_SEARCH=true
|
| 86 |
```
|
| 87 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 88 |
## 3. SubAgent - back run & tool call agent and swap file output
|
| 89 |
|
| 90 |
### 3.1 Auto Creat SubAgent
|
|
|
|
| 11 |
curl -fsSL https://raw.githubusercontent.com/versperai/VersperClaw/main/install.sh | bash
|
| 12 |
|
| 13 |
# source install
|
| 14 |
+
git clone https://github.com/versperai/VersperClaw.git && cd VersperClaw && bun install && bun run build:dev:full && ./VersperClaw
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 15 |
|
| 16 |
+
# if want global use bin file
|
| 17 |
+
cp VersperClaw ~/.local/bin
|
| 18 |
+
# then can use VersperClaw in everywhere
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
```
|
| 20 |
|
| 21 |
## 2. WebSearch & WebFetch Tools - 100% local free no remote api fee
|
|
|
|
| 28 |
</tr>
|
| 29 |
</table>
|
| 30 |
|
| 31 |
+
### Choice One - SearXNG:
|
| 32 |
+
|
| 33 |
+
#### 1. Docker Configuration
|
| 34 |
+
|
| 35 |
```bash
|
| 36 |
# local config search engine - searxng in archlinux
|
| 37 |
# make sure have install docker and docker-compose
|
|
|
|
| 43 |
sudo systemctl enable --now docker
|
| 44 |
```
|
| 45 |
|
| 46 |
+
#### 2. Docker-Compose Pull
|
| 47 |
+
|
| 48 |
+
> use VersperSearch a pre-build docker config in https://github.com/versperai/VersperSearch
|
| 49 |
+
|
| 50 |
```bash
|
| 51 |
+
# or install searxng in docker-compose by yourself
|
| 52 |
curl -fsSL \
|
| 53 |
-O https://raw.githubusercontent.com/searxng/searxng/master/container/docker-compose.yml \
|
| 54 |
-O https://raw.githubusercontent.com/searxng/searxng/master/container/.env.example
|
|
|
|
| 56 |
# add json source in formats behind html - jsonl in 87 lines
|
| 57 |
cd searxng/core-config/ && sudo nvim settings.yml
|
| 58 |
|
|
|
|
|
|
|
| 59 |
# start searxng engine
|
| 60 |
docker compose up -d
|
| 61 |
+
```
|
| 62 |
|
| 63 |
+
#### 3. Check Search Feature
|
| 64 |
+
|
| 65 |
+
```bash
|
| 66 |
# check in every browser
|
| 67 |
firefox http://localhost:8080
|
| 68 |
|
|
|
|
| 77 |
export ENABLE_TOOL_SEARCH=true
|
| 78 |
```
|
| 79 |
|
| 80 |
+
### Choice Two - Tavily:
|
| 81 |
+
|
| 82 |
+
> when TAVILY_API_KEY is set in env
|
| 83 |
+
|
| 84 |
## 3. SubAgent - back run & tool call agent and swap file output
|
| 85 |
|
| 86 |
### 3.1 Auto Creat SubAgent
|
package-lock.json
DELETED
|
The diff for this file is too large to render.
See raw diff
|
|
|