# autoclaw

**Repository Path**: mikefengshi/autoclaw

## Basic Information

- **Project Name**: autoclaw
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-25
- **Last Updated**: 2026-03-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AutoClaw 🦞

[![NPM Version](https://img.shields.io/npm/v/autoclaw.svg?style=flat-square)](https://www.npmjs.com/package/autoclaw)
[![NPM Downloads](https://img.shields.io/npm/dm/autoclaw.svg?style=flat-square)](https://www.npmjs.com/package/autoclaw)
[![GitHub](https://img.shields.io/badge/GitHub-Repository-blue?logo=github&style=flat-square)](https://github.com/tsingliuwin/autoclaw)
[![License](https://img.shields.io/npm/l/autoclaw.svg?style=flat-square)](https://github.com/tsingliuwin/autoclaw/blob/main/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

**稳定、高工程化、易规模化：专为无界面系统设计的高效自动化 Agent 框架。**

[English](./README.md) | 简体中文

---

🔗 **GitHub 仓库**: [https://github.com/tsingliuwin/autoclaw](https://github.com/tsingliuwin/autoclaw)

---

AutoClaw 是一款针对 **“无界面系统” (Headless Systems)** 的高稳定性自动化 Agent 开源框架。

相比于 OpenClaw 等需要“看屏幕”的 Agent（如视觉解析），AutoClaw 采用纯指令驱动，具有更强的**工程化**属性、更高的**稳定性**，以及极易**规模化**的特点。它专为在各种复杂环境中执行确定性的自动化任务而设计——无论是本地服务器、CI/CD 流水线，还是成千上万个容器节点。

## 为什么选择 AutoClaw?

- 🐳 **Docker 友好**: 专为容器化环境设计，无 GUI 依赖，极致轻量（Node.js/Alpine 友好）。
- 🚀 **更强工程化 (Better Engineering)**: 并非依赖不稳定的视觉识别，而是通过系统 API 和 Shell 指令精准操作，确保任务执行的确定性。
- 🛡️ **高稳定性 (Superior Stability)**: 摆脱了图形界面渲染、屏幕分辨率、网络延迟对视觉识别的影响，即便在极端的 Headless 环境下也能稳定运行。
- 📈 **易于规模化 (Massive Scalability)**: 低资源占用使得你可以同时编排成千上万个 Agent 实例（如在 Kubernetes 集群中），实现真正的自动化蜂群。
- 🔌 **集群就绪 (Swarm Ready)**: 无状态设计，支持通过 K8s、Docker Swarm 或简单的 Shell 脚本进行大规模调度。
- 🧩 **可扩展集成**: 内置支持网页搜索 (Tavily)、邮件发送 (SMTP) 以及通知钩子 (飞书、钉钉、企业微信)。

## 特性

- 📜 **无头执行 (Headless Execution)**: 真正的无头模式，无需浏览器或图形化界面。
- 🤖 **非交互模式**: 支持自动化标志（`-y`, `--no-interactive`），完美适配零干预的自动化流程。
- 📂 **全方位控制 (Universal Control)**: 从基础的文件 I/O 到复杂的系统管理与代码重构。
- 🧠 **上下文感知 (Context Aware)**: 自动识别操作系统与容器环境，并提供精确的系统时间以处理相对时间查询。
- 🌐 **网页搜索**: 集成 Tavily，支持实时信息检索。
- 🕒 **时间精准**: 内置工具获取精确系统日期和时间，确保正确的时间上下文。
- 📧 **通讯能力**: 自动发送电子邮件并将通知推送至聊天群组。

## 技术栈
- **运行时**: Node.js
- **语言**: TypeScript
- **框架**: Commander.js
- **UI**: Inquirer (交互), Chalk (样式), Ora (加载动画)
- **AI**: OpenAI SDK (兼容 DeepSeek, LocalLLM 等)

## 安装

### 用户安装
通过 npm 全局安装：
```bash
npm install -g autoclaw
```

### 开发安装
1.  克隆仓库：
    ```bash
    git clone https://github.com/tsingliuwin/autoclaw.git
    cd autoclaw
    ```
2.  安装依赖：
    ```bash
    npm install
    ```
3.  构建项目：
    ```bash
    npm run build
    ```
4.  全局链接 (可选)：
    ```bash
    npm link
    ```

## 快速上手

1.  **配置**: 运行交互式设置向导以配置您的 API 密钥和集成插件。
    ```bash
    autoclaw setup
    ```
2.  **运行**: 在交互模式下启动 Agent。
    ```bash
    autoclaw
    ```

## 使用方法

### 交互模式
直接运行 `autoclaw` 进入对话循环。
```bash
autoclaw
> 列出 src 文件夹中所有的 TypeScript 文件。
```

### 无头模式 (一次性任务)
执行单个指令后立即退出。
```bash
autoclaw "检查磁盘使用情况并将报告保存到 usage.txt" --no-interactive
```

### 自动确认 (CI/CD)
自动批准所有工具执行（危险操作，请谨慎使用或在沙箱环境下运行）。
```bash
autoclaw "将 src/index.ts 重构为使用 ES 模块" -y
```

### CLI 选项
- `-m, --model <model>`: 指定 LLM 模型 (默认: `gpt-4o`)。
- `-n, --no-interactive`: 处理完初始查询后退出 (无头模式)。
- `-y, --yes`: 自动确认所有工具执行 (例如 Shell 命令)。

## 配置

AutoClaw 使用层级配置系统。

**优先级排序 (从高到低):**
1.  **CLI 参数**: (例如 `-m gpt-4o`)
2.  **环境变量**: (`OPENAI_API_KEY`, `.env` 文件)
3.  **项目配置**: (当前目录下的 `./.autoclaw/setting.json`)
4.  **全局配置**: (`~/.autoclaw/setting.json`)

### 支持的配置键 (JSON)
- `apiKey`: 您的 OpenAI API 密钥。
- `baseUrl`: 自定义 API 基础地址 (例如 DeepSeek 或本地 LLM)。
- `model`: 默认使用的模型。
- `tavilyApiKey`: Tavily 网页搜索的 API 密钥。
- `smtpHost`, `smtpPort`, `smtpUser`, `smtpPass`, `smtpFrom`: SMTP 邮件设置。
- `feishuWebhook`, `dingtalkWebhook`, `wecomWebhook`: 通知钩子地址。

### 项目级配置示例
在 `.autoclaw/setting.json` 创建文件：
```json
{
  "model": "gpt-3.5-turbo",
  "baseUrl": "https://api.deepseek.com/v1"
}
```

> **⚠️ 安全警告**: 如果您在 `.autoclaw/setting.json` 中存储了 `apiKey` 或机密信息，请务必将 `.autoclaw/` 添加到您的 `.gitignore` 文件中，以防泄露！

## 集成功能

### 网页搜索 (Tavily)
如果您在设置中提供了 Tavily API 密钥，AutoClaw 可以搜索网页。
- **示例**: "搜索最新的 Node.js 发布说明。"

### 邮件 (SMTP)
配置 SMTP 设置以允许 Agent 发送邮件。
- **示例**: "向 user@example.com 发送一封包含日志文件摘要的邮件。"

### 通知 (飞书/钉钉/企业微信)
配置 Webhook 以在团队聊天应用中接收警报或报告。
- **示例**: "在飞书上通知团队构建已完成。"

### 日期与时间
内置工具为 Agent 提供当前系统时间，确保准确处理相对时间请求。
- **示例**: "今天是几号？" 或 "提醒我下周一检查日志。"

## Docker 支持

### 截图中的中文显示问题
在 Docker 容器（尤其是 Alpine 或 Debian Slim）中运行时，网页截图中的中文可能会显示为方块（"豆腐块"）。表情符号（如 🔥）也可能显示为方块。

**解决方案:** 在容器中安装 CJK（中日韩）和 Emoji 字体。

**Debian/Ubuntu:**
```bash
apt-get update && apt-get install -y fonts-noto-cjk fonts-wqy-zenhei fonts-noto-color-emoji
```

**Alpine Linux:**
```bash
apk add font-noto-cjk font-noto-emoji
```

## 开源协议

MIT

## 贡献指南

欢迎贡献！请随时提交 Pull Request。

1.  Fork 本项目
2.  创建您的特性分支 (`git checkout -b feature/AmazingFeature`)
3.  提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
4.  推送至分支 (`git push origin feature/AmazingFeature`)
5.  开启一个 Pull Request

---
GitHub: [https://github.com/tsingliuwin/autoclaw](https://github.com/tsingliuwin/autoclaw)