Skip to content

TOOLS.md

Latest commit

 

History

History
105 lines (71 loc) · 3.63 KB

TOOLS.md

File metadata and controls

105 lines (71 loc) · 3.63 KB
# TOOLS.md - Tool Configuration & Notes (工具配置与备忘录)

> Document tool-specific configurations, gotchas, and credentials here.
> (在此记录特定工具的配置、易错点和凭据位置。)

---

## 🔑 Credentials Location (凭据存储位置)

All credentials stored in `.credentials/` (gitignored):
(所有凭据存放在 `.credentials/` 目录中，已忽略 git 追踪：)

- `openclaw-env.txt` — API Keys & Env Variables (环境变量)
- `ssh-keys.pem` — Remote Access Keys (远程访问密钥)

*Note: Never write actual passwords in this file.*
*(注意：切勿在此文件中直接明文写入密码。)*

---

## [OpenClaw Environment] (运行环境配置)

**Status:** ✅ Working (正常运行)

**Configuration (配置详情):**
```text
[System Paths]
User: eisenbot
Workspace Root: /home/eisenbot/.openclaw/workspace/
Logs File: /home/eisenbot/.openclaw/workspace/openclaw_logs.txt
Scripts Dir: /home/eisenbot/.openclaw/workspace/scripts/

[Key Components]
Core Configs: SOUL.md (Agent身份), USER.md (用户偏好), AGENTS.md (操作规则)
Runtime Scripts: heartbeat.sh, scripts/security-audit.sh
State Storage: memory/ (目录), SESSION-STATE.md
Backups: backup_v1.2.3/

Gotchas (易错点/避坑指南):

  • Absolute Paths (绝对路径): Always use full paths (/home/eisenbot/...) in scripts or cron jobs. Relative paths (./) often fail in automated tasks. (在脚本或定时任务中永远使用绝对路径。相对路径容易导致自动任务失败。)
  • Permissions (权限): Ensure scripts are executable (chmod +x script.sh). (确保脚本拥有执行权限。)
  • Log Rotation (日志轮转): openclaw_logs.txt can grow huge. Monitor its size. (日志文件可能会无限增长，需注意监控其大小。)
  • File Conflict (文件冲突): SOUL.md defines Identity. If IDENTITY.md exists, it is likely redundant—check before editing. (SOUL.md 是定义身份的主文件。如果存在 IDENTITY.md，可能是冗余文件，编辑前请检查。)

Common Operations (常用操作):

# 1. Enter Workspace (进入工作区)
cd /home/eisenbot/.openclaw/workspace/

# 2. View Live Logs (查看实时日志)
tail -f openclaw_logs.txt

# 3. Manual Heartbeat (手动触发心跳)
./heartbeat.sh

# 4. Run Security Audit (运行安全审计)
./scripts/security-audit.sh

# 5. Backup Configs (备份配置)
cp -r . backup_v1.2.4_$(date +%F)/

✍️ Writing Preferences (Agent 写作偏好)

[OpenClaw Agent Instructions]

  • Style: Code-First, High-Density. (代码优先，高信息密度)
  • Language: Chinese (中文) for explanations, English for code/logs. (解释用中文，代码用英文)
  • Context: Assume you are on the eisenbot Linux server. (默认处于 Linux 服务器环境)
  • Constraint: Do NOT use relative paths for system configs. (系统配置中严禁使用相对路径)

ℹ️ What Goes Here (这里填什么)

  • Tool configurations: Paths, versions, dependencies. (路径、版本、依赖)
  • Credential locations: Where keys are hidden. (密钥藏在哪)
  • Gotchas: "Don't do X, it breaks Y." (踩过的坑)
  • Common commands: Copy-paste ready snippets. (可直接复制的命令)

Why Separate? (为什么要分开写？)

Skills define how tools work generally. This file is for your specifics — the unique setup of the eisenbot server. (Skill 文件定义工具的通用原理。而这个文件记录的是你这台服务器独有的具体配置。)

Add whatever helps you do your job. This is your cheat sheet. (添加任何能帮你工作的能容。这是你的作弊条。)