mirror of
https://github.com/sipeed/picoclaw.git
synced 2026-06-12 18:08:54 +00:00
esubaalew
838a69085b
- Fix DingTalk section referencing "QQ numbers" instead of DingTalk user IDs - Fix Anthropic example showing OAuth when code uses paste-token auth - Replace OpenClaw references in ANTIGRAVITY_AUTH.md with actual PicoClaw paths and Go patterns - Fix auth file path from auth-profiles.json to auth.json in ANTIGRAVITY_USAGE.md - Remove non-existent approval tool from tools_configuration.md, add skills tool docs - Update Quick Start configs in fr/pt-br/vi/ja translations to use model_list format - Fix allowFrom camelCase to allow_from in fr/pt-br translations - Fix camelCase config keys in ja translation - Update zh/ja web search config from old flat format to brave/duckduckgo - Fix broken ClawdChat link and trailing commas in zh translation - Add missing qwen/cerebras providers to fr/pt-br/vi translation tables - Add missing protocol prefixes to migration guide - Fix typos in community roadmap
144 lines
4.0 KiB
Markdown
144 lines
4.0 KiB
Markdown
# Tools Configuration
|
|
|
|
PicoClaw's tools configuration is located in the `tools` field of `config.json`.
|
|
|
|
## Directory Structure
|
|
|
|
```json
|
|
{
|
|
"tools": {
|
|
"web": { ... },
|
|
"exec": { ... },
|
|
"cron": { ... },
|
|
"skills": { ... }
|
|
}
|
|
}
|
|
```
|
|
|
|
## Web Tools
|
|
|
|
Web tools are used for web search and fetching.
|
|
|
|
### Brave
|
|
|
|
| Config | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `enabled` | bool | false | Enable Brave search |
|
|
| `api_key` | string | - | Brave Search API key |
|
|
| `max_results` | int | 5 | Maximum number of results |
|
|
|
|
### DuckDuckGo
|
|
|
|
| Config | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `enabled` | bool | true | Enable DuckDuckGo search |
|
|
| `max_results` | int | 5 | Maximum number of results |
|
|
|
|
### Perplexity
|
|
|
|
| Config | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `enabled` | bool | false | Enable Perplexity search |
|
|
| `api_key` | string | - | Perplexity API key |
|
|
| `max_results` | int | 5 | Maximum number of results |
|
|
|
|
## Exec Tool
|
|
|
|
The exec tool is used to execute shell commands.
|
|
|
|
| Config | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `enable_deny_patterns` | bool | true | Enable default dangerous command blocking |
|
|
| `custom_deny_patterns` | array | [] | Custom deny patterns (regular expressions) |
|
|
|
|
### Functionality
|
|
|
|
- **`enable_deny_patterns`**: Set to `false` to completely disable the default dangerous command blocking patterns
|
|
- **`custom_deny_patterns`**: Add custom deny regex patterns; commands matching these will be blocked
|
|
|
|
### Default Blocked Command Patterns
|
|
|
|
By default, PicoClaw blocks the following dangerous commands:
|
|
|
|
- Delete commands: `rm -rf`, `del /f/q`, `rmdir /s`
|
|
- Disk operations: `format`, `mkfs`, `diskpart`, `dd if=`, writing to `/dev/sd*`
|
|
- System operations: `shutdown`, `reboot`, `poweroff`
|
|
- Command substitution: `$()`, `${}`, backticks
|
|
- Pipe to shell: `| sh`, `| bash`
|
|
- Privilege escalation: `sudo`, `chmod`, `chown`
|
|
- Process control: `pkill`, `killall`, `kill -9`
|
|
- Remote operations: `curl | sh`, `wget | sh`, `ssh`
|
|
- Package management: `apt`, `yum`, `dnf`, `npm install -g`, `pip install --user`
|
|
- Containers: `docker run`, `docker exec`
|
|
- Git: `git push`, `git force`
|
|
- Other: `eval`, `source *.sh`
|
|
|
|
### Configuration Example
|
|
|
|
```json
|
|
{
|
|
"tools": {
|
|
"exec": {
|
|
"enable_deny_patterns": true,
|
|
"custom_deny_patterns": [
|
|
"\\brm\\s+-r\\b",
|
|
"\\bkillall\\s+python"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Cron Tool
|
|
|
|
The cron tool is used for scheduling periodic tasks.
|
|
|
|
| Config | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `exec_timeout_minutes` | int | 5 | Execution timeout in minutes, 0 means no limit |
|
|
|
|
## Skills Tool
|
|
|
|
The skills tool configures skill discovery and installation via registries like ClawHub.
|
|
|
|
### Registries
|
|
|
|
| Config | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `registries.clawhub.enabled` | bool | true | Enable ClawHub registry |
|
|
| `registries.clawhub.base_url` | string | `https://clawhub.ai` | ClawHub base URL |
|
|
| `registries.clawhub.search_path` | string | `/api/v1/search` | Search API path |
|
|
| `registries.clawhub.skills_path` | string | `/api/v1/skills` | Skills API path |
|
|
| `registries.clawhub.download_path` | string | `/api/v1/download` | Download API path |
|
|
|
|
### Configuration Example
|
|
|
|
```json
|
|
{
|
|
"tools": {
|
|
"skills": {
|
|
"registries": {
|
|
"clawhub": {
|
|
"enabled": true,
|
|
"base_url": "https://clawhub.ai",
|
|
"search_path": "/api/v1/search",
|
|
"skills_path": "/api/v1/skills",
|
|
"download_path": "/api/v1/download"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
All configuration options can be overridden via environment variables with the format `PICOCLAW_TOOLS_<SECTION>_<KEY>`:
|
|
|
|
For example:
|
|
- `PICOCLAW_TOOLS_WEB_BRAVE_ENABLED=true`
|
|
- `PICOCLAW_TOOLS_EXEC_ENABLE_DENY_PATTERNS=false`
|
|
- `PICOCLAW_TOOLS_CRON_EXEC_TIMEOUT_MINUTES=10`
|
|
|
|
Note: Array-type environment variables are not currently supported and must be set via the config file.
|