opencode/picoclaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: revert unintentional bullet style changes

Browse source
This commit is contained in:
Ali Zulfiqar 2026-02-22 12:57:02 +05:00
parent e47bb1a360
commit a83188d190
1 changed files with 49 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

100
README.md
View file

@ -42,11 +42,12 @@
> [!CAUTION] > [!CAUTION]
> **🚨 SECURITY & OFFICIAL CHANNELS / 安全声明** > **🚨 SECURITY & OFFICIAL CHANNELS / 安全声明**
> >
> - **NO CRYPTO:** PicoClaw has **NO** official token/coin. All claims on `pump.fun` or other trading platforms are **SCAMS**. > * **NO CRYPTO:** PicoClaw has **NO** official token/coin. All claims on `pump.fun` or other trading platforms are **SCAMS**.
> - **OFFICIAL DOMAIN:** The **ONLY** official website is **[picoclaw.io](https://picoclaw.io)**, and company website is **[sipeed.com](https://sipeed.com)** >
> - **Warning:** Many `.ai/.org/.com/.net/...` domains are registered by third parties. > * **OFFICIAL DOMAIN:** The **ONLY** official website is **[picoclaw.io](https://picoclaw.io)**, and company website is **[sipeed.com](https://sipeed.com)**
> - **Warning:** picoclaw is in early development now and may have unresolved network security issues. Do not deploy to production environments before the v1.0 release. > * **Warning:** Many `.ai/.org/.com/.net/...` domains are registered by third parties.
> - **Note:** picoclaw has recently merged a lot of PRs, which may result in a larger memory footprint (10–20MB) in the latest versions. We plan to prioritize resource optimization as soon as the current feature set reaches a stable state. > * **Warning:** picoclaw is in early development now and may have unresolved network security issues. Do not deploy to production environments before the v1.0 releas\*.
> * **Note:** picoclaw has recently merged a lot of PRs, which may result in a larger memory footprint (10–20MB) in the latest versions. We plan to prioritize resource optimization as soon as the current feature set reaches a stable state.
## 📢 News ## 📢 News
@ -245,15 +246,15 @@ picoclaw onboard
} }
} }
} }
} *
``` ```
> **New**: The `model_list` configuration format allows zero-code provider addition. See [Model Configuration](#model-configuration-model_list) for details. > **New**: The `model_list` configuration format allows zero-code provider addition. See [Model Configuration](#model-configuration-model_list) for details.
**3. Get API Keys** **3. Get API Keys**
- **LLM Provider**: [OpenRouter](https://openrouter.ai/keys) · [Zhipu](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys) · [Anthropic](https://console.anthropic.com) · [OpenAI](https://platform.openai.com) · [Gemini](https://aistudio.google.com/api-keys) * **LLM Provider**: [OpenRouter](https://openrouter.ai/keys) · [Zhipu](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys) · [Anthropic](https://console.anthropic.com) · [OpenAI](https://platform.openai.com) · [Gemini](https://aistudio.google.com/api-keys)
- **Web Search** (optional): [Brave Search](https://brave.com/search/api) - Free tier available (2000 requests/month) * **Web Search** (optional): [Brave Search](https://brave.com/search/api) - Free tier available (2000 requests/month)
> **Note**: See `config.example.json` for a complete configuration template. > **Note**: See `config.example.json` for a complete configuration template.
@ -285,9 +286,9 @@ Talk to your picoclaw through Telegram, Discord, DingTalk, LINE, or WeCom
**1. Create a bot** **1. Create a bot**
- Open Telegram, search `@BotFather` * Open Telegram, search `@BotFather`
- Send `/newbot`, follow prompts * Send `/newbot`, follow prompts
- Copy the token * Copy the token
**2. Configure** **2. Configure**
@ -318,19 +319,18 @@ picoclaw gateway
**1. Create a bot** **1. Create a bot**
- Go to <https://discord.com/developers/applications> * Go to <https://discord.com/developers/applications>
- Create an application → Bot → Add Bot * Create an application → Bot → Add Bot
- Copy the bot token * Copy the bot token
**2. Enable intents** **2. Enable intents**
- In the Bot settings, enable **MESSAGE CONTENT INTENT** * In the Bot settings, enable **MESSAGE CONTENT INTENT**
- (Optional) Enable **SERVER MEMBERS INTENT** if you plan to use allow lists based on member data * (Optional) Enable **SERVER MEMBERS INTENT** if you plan to use allow lists based on member data
**3. Get your User ID** **3. Get your User ID***
* Discord Settings → Advanced → enable **Developer Mode**
- Discord Settings → Advanced → enable **Developer Mode** * Right-click your avatar → **Copy User ID**
- Right-click your avatar → **Copy User ID**
**4. Configure** **4. Configure**
@ -349,10 +349,10 @@ picoclaw gateway
**5. Invite the bot** **5. Invite the bot**
- OAuth2 → URL Generator * OAuth2 → URL Generator
- Scopes: `bot` * Scopes: `bot`
- Bot Permissions: `Send Messages`, `Read Message History` * Bot Permissions: `Send Messages`, `Read Message History`
- Open the generated invite URL and add the bot to your server * Open the generated invite URL and add the bot to your server
**Optional: Mention-only mode** **Optional: Mention-only mode**
@ -404,9 +404,9 @@ picoclaw gateway
**1. Create a bot** **1. Create a bot**
- Go to [Open Platform](https://open.dingtalk.com/) * Go to [Open Platform](https://open.dingtalk.com/)
- Create an internal app * Create an internal app
- Copy Client ID and Client Secret * Copy Client ID and Client Secret
**2. Configure** **2. Configure**
@ -429,8 +429,7 @@ picoclaw gateway
```bash ```bash
picoclaw gateway picoclaw gateway
``` ```*
</details> </details>
<details> <details>
@ -497,8 +496,8 @@ See [WeCom App Configuration Guide](docs/wecom-app-configuration.md) for detaile
**1. Create a bot** **1. Create a bot**
- Go to WeCom Admin Console → Group Chat → Add Group Bot * Go to WeCom Admin Console → Group Chat → Add Group Bot
- Copy the webhook URL (format: `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx`) * Copy the webhook URL (format: `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx`)
**2. Configure** **2. Configure**
@ -523,15 +522,14 @@ See [WeCom App Configuration Guide](docs/wecom-app-configuration.md) for detaile
**1. Create an app** **1. Create an app**
- Go to WeCom Admin Console → App Management → Create App * Go to WeCom Admin Console → App Management → Create App
- Copy **AgentId** and **Secret** * Copy **AgentId** and **\*ecret**
- Go to "My Company" page, copy **CorpID** * Go to "My Company" page, copy **CorpID***
**2. Configure receive message** **2. Configure receive message**
- In App details, click "Receive Message" → "Set API" * In App details, click "Receive Message" → "Set API"
- Set URL to `http://your-server:18792/webhook/wecom-app` * Set URL to `http://your-server:18792/webhook/wecom-app`
- Generate **Token** and **EncodingAESKey** * Generate **Token** and **EncodingAESKey**
**3. Configure** **3. Configure**
@ -632,12 +630,12 @@ When `restrict_to_workspace: true`, the following tools are sandboxed:
Even with `restrict_to_workspace: false`, the `exec` tool blocks these dangerous commands: Even with `restrict_to_workspace: false`, the `exec` tool blocks these dangerous commands:
- `rm -rf`, `del /f`, `rmdir /s` — Bulk deletion * `rm -rf`, `del /f`, `rmdir /s` — Bulk deletion
- `format`, `mkfs`, `diskpart` — Disk formatting * `format`, `mkfs`, `diskpart` — Disk formatting
- `dd if=` — Disk imaging * `dd if=` — Disk imaging
- Writing to `/dev/sd[a-z]` — Direct disk writes * Writing to `/dev/sd[a-z]` — Direct disk writes
- `shutdown`, `reboot`, `poweroff` — System shutdown * `shutdown`, `reboot`, `poweroff` — System shutdown
- Fork bomb `:(){ :|:& };:` * Fork bomb `:(){ :|:& };:`
#### Error Examples #### Error Examples
@ -763,8 +761,8 @@ The subagent has access to tools (message, web_search, etc.) and can communicate
**Environment variables:** **Environment variables:**
- `PICOCLAW_HEARTBEAT_ENABLED=false` to disable * `PICOCLAW_HEARTBEAT_ENABLED=false` to disable
- `PICOCLAW_HEARTBEAT_INTERVAL=60` to change interval * `PICOCLAW_HEARTBEAT_INTERVAL=60` to change interval
### Providers ### Providers
@ -986,12 +984,12 @@ PicoClaw routes providers by protocol family:
This keeps the runtime lightweight while making new OpenAI-compatible backends mostly a config operation (`api_base` + `api_key`). This keeps the runtime lightweight while making new OpenAI-compatible backends mostly a config operation (`api_base` + `api_key`).
<details> <details*
<summary><b>Zhipu</b></summary> <summary><b>Zhipu</b></summary>
**1. Get API key and base URL** **1. Get API key and base URL**
- Get [API key](https://bigmodel.cn/usercenter/proj-mgmt/apikeys) * Get [API key](https://bigmodel.cn/usercenter/proj-mgmt/apikeys)
**2. Configure** **2. Configure**
@ -1111,9 +1109,9 @@ picoclaw agent -m "Hello"
PicoClaw supports scheduled reminders and recurring tasks through the `cron` tool: PicoClaw supports scheduled reminders and recurring tasks through the `cron` tool:
- **One-time reminders**: "Remind me in 10 minutes" → triggers once after 10min * **One-time reminders**: "Remind me in 10 minutes" → triggers once after 10min
- **Recurring tasks**: "Remind me every 2 hours" → triggers every 2 hours * **Recurring tasks**: "Remind me every 2 hours" → triggers every 2 hours
- **Cron expressions**: "Remind me at 9am daily" → uses cron expression * **Cron expressions**: "Remind me at 9am daily" → uses cron expression
Jobs are stored in `~/.picoclaw/workspace/cron/` and processed automatically. Jobs are stored in `~/.picoclaw/workspace/cron/` and processed automatically.