Skip to content
ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

43 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

NGOClaw

Autonomous AI Agent Framework โ€” Pure Go, batteries included
่‡ชไธป AI Agent ๆก†ๆžถ โ€” ็บฏ Go ๅฎž็Žฐ๏ผŒๅผ€็ฎฑๅณ็”จ

Quick Start โ€ข Features โ€ข Architecture โ€ข Configuration โ€ข User Manual โ€ข SDK

MIT License Go 1.24+ DDD


NGOClaw is a self-hosted, autonomous AI agent running a full ReAct loop (Reason โ†’ Act โ†’ Observe) with 25 built-in tools, MCP protocol support, hot-pluggable skills/prompts, and multi-channel interfaces.

NGOClaw ๆ˜ฏไธ€ไธช่‡ชๆ‰˜็ฎก็š„่‡ชไธป AI Agent๏ผŒ่ฟ่กŒๅฎŒๆ•ด็š„ ReAct ๅพช็Žฏ๏ผˆๆŽจ็†โ†’่กŒๅŠจโ†’่ง‚ๅฏŸ๏ผ‰๏ผŒๅ†…็ฝฎ 25 ไธชๅทฅๅ…ท๏ผŒๆ”ฏๆŒ MCP ๅ่ฎฎใ€็ƒญๆ’ๆ‹”ๆŠ€่ƒฝ/ๆ็คบ่ฏ็ณป็ปŸๅ’Œๅคš้€š้“ๆŽฅๅฃใ€‚


๐Ÿ“Œ News

  • [2026-03-01] ๐Ÿš€ Engine ๆžถๆž„ + ็ปŸไธ€้€š้“ โ€” ๆ–ฐๅขž Engine ไฝœไธบๆ ธๅฟƒ็Šถๆ€ๆŒๆœ‰่€…๏ผŒChannelSender ๆŽฅๅฃๅฎž็Žฐ้€š้“ๆ— ๅ…ณๆถˆๆฏๅ‘้€๏ผŒ็ปŸไธ€ message ๅทฅๅ…ทๆ›ฟไปฃ 3 ไธช TG ไธ“็”จๅทฅๅ…ท๏ผŒgRPC metadata ไผ ้€’ chatID ่งฃๅ†ณ่ทจ่ฟ›็จ‹ไธŠไธ‹ๆ–‡ไธขๅคฑ
  • [2026-02-28] ๐ŸŒ WebChat UI ไผ˜ๅŒ– โ€” ้‡ๆ–ฐ่ฎพ่ฎกๆถˆๆฏๆฐ”ๆณกใ€ไพง่พนๆ ใ€ๆถˆๆฏๅฏน้ฝๅ’Œ้—ด่ท๏ผŒๅฏน้ฝ Open WebUI ่ฎพ่ฎก่ง„่Œƒ
  • [2026-02-25] ๐Ÿง  ๆ™บ่ƒฝ Prompt Dispatch โ€” ๆ นๆฎๆจกๅž‹่ƒฝๅŠ›ๅŠจๆ€่ฐƒๆ•ด Prompt ่ฏฆ็ป†ๅบฆ๏ผˆdetailed/concise/minimal๏ผ‰๏ผŒๆ”ฏๆŒ intent ่ฟ‡ๆปค
  • [2026-02-23] ๐Ÿ”— Remote Deploy โ€” CLI ไธ€้”ฎ้ƒจ็ฝฒๅˆฐ่ฟœ็ซฏ Linux ่ฎพๅค‡๏ผŒๆ”ฏๆŒ systemd/procd/sysvinit
  • [2026-02-16] ๐Ÿ“ Prompt ๆžถๆž„้‡่ฎพ่ฎก โ€” ไธ‰ๅฑ‚ๆžถๆž„๏ผˆSystem/Workspace/Channel๏ผ‰๏ผŒ็ƒญๆ’ๆ‹”็ป„ไปถ๏ผŒๆจกๅž‹ๅ˜ไฝ“ๆ”ฏๆŒ

โœจ Features / ๅŠŸ่ƒฝไบฎ็‚น

Feature / ๅŠŸ่ƒฝ Description / ่ฏดๆ˜Ž
๐Ÿค– ReAct Agent Loop Reason โ†’ Act โ†’ Observe with automatic multi-step planning / ๆŽจ็†โ†’่กŒๅŠจโ†’่ง‚ๅฏŸ๏ผŒ่‡ชๅŠจ่ง„ๅˆ’ๅคšๆญฅไปปๅŠก
๐Ÿ”ง 27 Built-in Tools File I/O, async shell, web search, code intelligence, browser, media, git, LSP / ๆ–‡ไปถ่ฏปๅ†™ใ€ๅผ‚ๆญฅ Shellใ€ๆœ็ดขใ€ไปฃ็ ๆ™บ่ƒฝใ€ๆต่งˆๅ™จใ€ๅช’ไฝ“ๅ‘้€
๐ŸŒ Remote Control Deploy & control remote machines via gRPC โ€” auto cross-compile, multi-init-system, full tool proxy / ่ฟœ็จ‹่ฎพๅค‡็ฎกๆŽง๏ผš่‡ชๅŠจไบคๅ‰็ผ–่ฏ‘ใ€ๅคš init ็ณป็ปŸๆ”ฏๆŒใ€ๅฎŒๆ•ดๅทฅๅ…ทไปฃ็†
๐Ÿงฉ MCP Protocol One-click integration with Model Context Protocol / ไธ€้”ฎๆŽฅๅ…ฅ MCP ๅค–้ƒจๆœๅŠก
๐Ÿ“ฆ Hot-Pluggable Skills 9 built-in + drop SKILL.md into ~/.ngoclaw/skills/ โ€” auto-discovered / 9 ไธชๅ†…็ฝฎ + ๆ”พๅ…ฅๅณๅฏ่‡ชๅŠจๅ‘็Žฐ
๐Ÿ’ฌ Multi-Interface CLI (TUI) ยท Telegram Bot ยท HTTP API ยท gRPC ยท WebSocket ยท REPL
๐Ÿ”„ Multi-Provider OpenAI / Anthropic / Gemini / Bailian / MiniMax โ€” priority routing / ไผ˜ๅ…ˆ็บง่ทฏ็”ฑใ€่‡ชๅŠจๅฎน็พ
๐Ÿง  Context Compression XML summarization + memory extraction + Daily Log / XML ๆ‘˜่ฆ + ่ฎฐๅฟ†ๆๅ–
๐Ÿ›ก๏ธ Tool Sandbox Process-level isolation with configurable policies / ่ฟ›็จ‹็บง้š”็ฆป๏ผŒๅฏ้…ๅทฅๅ…ท็ญ–็•ฅ
โšก Hot Config config.yaml + MCP JSON + Prompts all support hot-reload / ๅ‡ๆ”ฏๆŒ็ƒญ้‡่ฝฝ
๐Ÿ“Š Observability EventBus + Monitoring + structured logging (Zap) / ็ป“ๆž„ๅŒ–ๆ—ฅๅฟ—

๐Ÿš€ Quick Start / ๅฟซ้€Ÿๅผ€ๅง‹

Prerequisites / ๅ‰็ฝฎไพ่ต–

  • Go 1.24+
  • At least one LLM Provider API key / ่‡ณๅฐ‘ไธ€ไธช LLM Provider API Key

Optional Dependencies / ๅฏ้€‰ไพ่ต–

Core features work without these. Only needed for specific tools: ๆ ธๅฟƒๅŠŸ่ƒฝๆ— ้œ€ไปฅไธ‹ไพ่ต–๏ผŒไป…็‰นๅฎšๅทฅๅ…ท้œ€่ฆ๏ผš

Feature / ๅŠŸ่ƒฝ Dependency / ไพ่ต– Notes / ่ฏดๆ˜Ž
web_search SearXNG instance Self-hosted metasearch engine. Configure URL in skill / ่‡ชๅปบๅ…ƒๆœ็ดขๅผ•ๆ“Ž
stock_analysis Python 3.10+ + Conda/venv pip install matplotlib pandas requests in your env / ่‚ก็ฅจๅˆ†ๆžๆŠ€่ƒฝ
Long-term Memory Ollama + embedding model e.g. ollama pull qwen3-embedding. Configure in config.yaml / ๅ‘้‡่ฎฐๅฟ†
Browser tools Chrome/Chromium CDP (Chrome DevTools Protocol) for browser_* tools / ๆต่งˆๅ™จ่‡ชๅŠจๅŒ–
Python skills Python 3.10+ + Conda/venv Set python_env in config.yaml / Python ๆŠ€่ƒฝ่ฟ่กŒ็Žฏๅขƒ

Build from Source / ๆบ็ ็ผ–่ฏ‘

git clone https://github.com/ngoclaw/ngoclaw.git
cd ngoclaw
make build          # โ†’ bin/ngoclaw
make install        # โ†’ /usr/local/bin/ngoclaw (optional, requires sudo / ๅฏ้€‰)

First Run / ้ฆ–ๆฌก่ฟ่กŒ

NGOClaw auto-creates ~/.ngoclaw/ with 20 seed files on first launch: NGOClaw ้ฆ–ๆฌกๅฏๅŠจ่‡ชๅŠจๅˆ›ๅปบ ~/.ngoclaw/ ๅนถ็”Ÿๆˆ 20 ไธช็งๅญๆ–‡ไปถ๏ผš

~/.ngoclaw/
โ”œโ”€โ”€ config.yaml              # Main config (fully commented) / ไธป้…็ฝฎ๏ผˆๅ…จๆณจ้‡Š๏ผ‰
โ”œโ”€โ”€ soul.md                  # Agent personality / Agent ไบบๆ ผ
โ”œโ”€โ”€ prompts/                 # 9 prompt components / ๆ็คบ่ฏ็ป„ไปถ
โ”‚   โ”œโ”€โ”€ rules.md             # Operating rules / ๆ“ไฝœ่ง„ๅˆ™
โ”‚   โ”œโ”€โ”€ coding.md            # Coding standards / ็ผ–็ ๆ ‡ๅ‡†
โ”‚   โ”œโ”€โ”€ safety.md            # Tool safety + remote rules / ๅทฅๅ…ทๅฎ‰ๅ…จ
โ”‚   โ”œโ”€โ”€ workflow.md          # Rโ†’Eโ†’V dev cycle / ๅผ€ๅ‘ๅพช็Žฏ
โ”‚   โ”œโ”€โ”€ compression.md       # Context compaction / ไธŠไธ‹ๆ–‡ๅŽ‹็ผฉ
โ”‚   โ”œโ”€โ”€ memory-rules.md      # Memory save rules / ่ฎฐๅฟ†่ง„ๅˆ™
โ”‚   โ”œโ”€โ”€ finance.md           # Financial analysis / ้‡‘่žๅˆ†ๆž
โ”‚   โ””โ”€โ”€ variants/            # Model-specific variants / ๆจกๅž‹ๅ˜ไฝ“
โ”œโ”€โ”€ skills/                  # 9 built-in skills / 9 ไธชๅ†…็ฝฎๆŠ€่ƒฝ
โ”‚   โ”œโ”€โ”€ systematic-debugging/    # Rโ†’Eโ†’V debugging / ็ณป็ปŸๅŒ–่ฐƒ่ฏ•
โ”‚   โ”œโ”€โ”€ writing-plans/           # Implementation planning / ่ฎกๅˆ’็ผ–ๅ†™
โ”‚   โ”œโ”€โ”€ executing-plans/         # Batch execution / ๅˆ†ๆ‰นๆ‰ง่กŒ
โ”‚   โ”œโ”€โ”€ brainstorming/           # Requirements exploration / ้œ€ๆฑ‚ๆŽข็ดข
โ”‚   โ”œโ”€โ”€ verification-before-completion/ # Evidence before claims / ๅฎŒๆˆๅ‰้ชŒ่ฏ
โ”‚   โ”œโ”€โ”€ remote-deploy/           # Remote device management / ่ฟœ็ซฏ็ฎก็†
โ”‚   โ”œโ”€โ”€ find-skills/             # Discover & install skills / ๅ‘็ŽฐๆŠ€่ƒฝ
โ”‚   โ”œโ”€โ”€ writing-skills/          # Create custom skills / ็ผ–ๅ†™ๆŠ€่ƒฝ
โ”‚   โ””โ”€โ”€ using-superpowers/       # Skill awareness / ๆŠ€่ƒฝๆ„่ฏ†
โ”œโ”€โ”€ memory/                  # Long-term memory / ้•ฟๆœŸ่ฎฐๅฟ†
โ””โ”€โ”€ logs/                    # Structured logs / ๆ—ฅๅฟ—

Edit config with your LLM provider / ็ผ–่พ‘้…็ฝฎๅกซๅ…ฅ LLM Provider ไฟกๆฏ๏ผš

agent:
  default_model: "your-provider/your-model"
  providers:
    - name: your-provider
      base_url: "https://api.example.com/v1"
      api_key: "your-api-key"
      models:
        - "your-provider/model-name"
      priority: 1

Launch / ๅฏๅŠจ๏ผš

ngoclaw          # Interactive CLI (TUI) / ไบคไบ’ๅผ็ปˆ็ซฏ
ngoclaw serve    # Background service / ๅŽๅฐๆœๅŠก (HTTP + Telegram + gRPC)

๐Ÿ—๏ธ Architecture / ๆžถๆž„

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚                    Interfaces Layer / ๆŽฅๅฃๅฑ‚                  โ”‚
โ”‚  CLI/TUI โ”‚ Telegram Bot โ”‚ HTTP API โ”‚ gRPC โ”‚ WebSocket โ”‚ REPLโ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚                   Application Layer / ๅบ”็”จๅฑ‚                 โ”‚
โ”‚              ProcessMessageUseCase ยท AgentLoop               โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚                     Domain Layer / ้ข†ๅŸŸๅฑ‚                     โ”‚
โ”‚  Entity โ”‚ ValueObject โ”‚ Service โ”‚ Tool โ”‚ Agent โ”‚ Memory      โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚                 Infrastructure Layer / ๅŸบ็ก€่ฎพๆ–ฝๅฑ‚             โ”‚
โ”‚  LLM Routerโ”‚Tool Registryโ”‚Prompt Engineโ”‚Sandboxโ”‚EventBus    โ”‚
โ”‚  Persistenceโ”‚Configโ”‚Monitoringโ”‚Pluginโ”‚VectorStoreโ”‚Embedding  โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

DDD Layered โ€” Domain logic has zero external dependencies; infrastructure is swappable. DDD ๅˆ†ๅฑ‚ โ€” ้ข†ๅŸŸ้€ป่พ‘้›ถๅค–้ƒจไพ่ต–๏ผ›ๅŸบ็ก€่ฎพๆ–ฝๅฏๆ›ฟๆข๏ผ›ๆŽฅๅฃๅฑ‚้šๆ„ๆ‰ฉๅฑ•ใ€‚

Core Flow / ๆ ธๅฟƒๆต็จ‹

User Input โ†’ Interface Routing โ†’ AgentLoop (ReAct)
็”จๆˆท่พ“ๅ…ฅ       ๆŽฅๅฃๅฑ‚่ทฏ็”ฑ              โ†“
                           LLM Router (multi-provider failover / ๅคš Provider ๅฎน็พ)
                                      โ†“
                           Reason โ†’ Tool Call โ†’ Observe โ†’ Loop
                           ๆŽจ็†       ๅทฅๅ…ท่ฐƒ็”จ     ่ง‚ๅฏŸ     ๅพช็Žฏ
                                      โ†“
                           Context Compression (automatic / ่‡ชๅŠจ)
                                      โ†“
                           Response Output / ๅ“ๅบ”่พ“ๅ‡บ

โš™๏ธ Configuration / ้…็ฝฎ

Config priority (low โ†’ high) / ้…็ฝฎไผ˜ๅ…ˆ็บง๏ผˆไฝŽโ†’้ซ˜๏ผ‰๏ผš

  1. Built-in defaults / ๅ†…็ฝฎ้ป˜่ฎคๅ€ผ
  2. ~/.ngoclaw/config.yaml โ€” Global / ๅ…จๅฑ€้…็ฝฎ
  3. ./config.yaml โ€” Project-local override / ้กน็›ฎๆœฌๅœฐ่ฆ†็›–
  4. NGOCLAW_* env vars / ็Žฏๅขƒๅ˜้‡

LLM Providers

agent:
  providers:
    - name: openai
      base_url: "https://api.openai.com/v1"
      api_key: "sk-..."
      models: ["openai/gpt-4o"]
      priority: 1

    - name: anthropic
      base_url: "https://api.anthropic.com/v1"
      api_key: "sk-ant-..."
      models: ["anthropic/claude-sonnet-4-20250514"]
      priority: 2

Telegram Bot

telegram:
  bot_token: "YOUR_BOT_TOKEN"
  allow_ids: [YOUR_TELEGRAM_USER_ID]
  mode: polling

MCP Servers

Edit ~/.ngoclaw/mcp.json:

{
  "servers": [
    {
      "name": "filesystem",
      "command": "npx",
      "args": ["-y", "@anthropic/mcp-filesystem", "/path/to/dir"]
    }
  ]
}

๐Ÿ”ง Built-in Tools / ๅ†…็ฝฎๅทฅๅ…ท (27)

Tool Kind Description / ่ฏดๆ˜Ž
run_command execute Async shell execution with background polling / ๅผ‚ๆญฅ Shell ๆ‰ง่กŒ
command_status read Check output/status of background command / ๆŸฅ็œ‹ๅŽๅฐๅ‘ฝไปค็Šถๆ€
send_input execute Send stdin to interactive command / ๅ‘้€่พ“ๅ…ฅๅˆฐไบคไบ’ๅผๅ‘ฝไปค
read_file read Read file contents / ่ฏปๅ–ๆ–‡ไปถ
write_file execute Create or overwrite files / ๅ†™ๅ…ฅๆ–‡ไปถ
edit_file execute Precise edits via search-and-replace / ็ฒพๅ‡†็ผ–่พ‘
list_dir read List directory contents / ๅˆ—็›ฎๅฝ•
grep_search read Regex search in files / ๆญฃๅˆ™ๆœ็ดข
glob read Find files by glob pattern / ๆŒ‰ๆจกๅผๆŸฅๆ‰พๆ–‡ไปถ
apply_patch execute Apply unified diff patches / ๅบ”็”จ่กฅไธ
web_search fetch Web search via SearXNG / ไบ’่”็ฝ‘ๆœ็ดข
web_fetch fetch Fetch URL content / ๆŠ“ๅ–็ฝ‘้กต
git execute Safe git ops (status/diff/log/commit/show) / ๅฎ‰ๅ…จ Git ๆ“ไฝœ
lint_fix execute Code quality checks (lint/test/build) / ไปฃ็ ่ดจ้‡ๆฃ€ๆŸฅ
lsp read LSP (definition/references/hover/diagnostics) / ่ฏญ่จ€ๆœๅŠก
repo_map read Generate codebase structure map / ไปฃ็ ๅœฐๅ›พ
save_memory think Save facts to long-term memory / ้•ฟๆœŸ่ฎฐๅฟ†
update_plan think Create/update execution plans / ไปปๅŠก่ฎกๅˆ’
spawn_agent execute Delegate to independent sub-agent / ๅญ Agent ๅง”ๆดพ
remote_exec execute Execute tools on remote machines via gRPC / ่ฟœ็ซฏๅทฅๅ…ทๆ‰ง่กŒ
list_remotes read List connected remote devices / ๆŸฅ็œ‹่ฟœ็ซฏ่ฎพๅค‡
send_photo execute Send photo via Telegram / ๅ‘้€ๅ›พ็‰‡
send_document execute Send document via Telegram / ๅ‘้€ๆ–‡ไปถ
mcp_manage execute Manage MCP servers / ็ฎก็† MCP ๆœๅŠกๅ™จ
stock_analysis fetch Stock data & technical analysis / ่‚ก็ฅจๅˆ†ๆž
browser_navigate fetch Navigate browser to URL / ๆต่งˆๅ™จๅฏผ่ˆช
browser_screenshot read Take page screenshot / ็ฝ‘้กตๆˆชๅ›พ

๐ŸŒ Remote Control / ่ฟœ็จ‹่ฎพๅค‡็ฎกๆŽง

NGOClaw can deploy itself to remote Linux machines and execute tools remotely via gRPC. NGOClaw ๅฏไปฅๅฐ†่‡ช่บซ้ƒจ็ฝฒๅˆฐ่ฟœ็จ‹ Linux ่ฎพๅค‡๏ผŒๅนถ้€š่ฟ‡ gRPC ่ฟœ็จ‹ๆ‰ง่กŒๅทฅๅ…ทใ€‚

# Deploy to a remote machine (auto: SSH probe โ†’ cross-compile โ†’ upload โ†’ install โ†’ start)
# ้ƒจ็ฝฒๅˆฐ่ฟœ็จ‹ๆœบๅ™จ๏ผˆๅ…จ่‡ชๅŠจ๏ผšSSH ๆŽขๆต‹ โ†’ ไบคๅ‰็ผ–่ฏ‘ โ†’ ไธŠไผ  โ†’ ๅฎ‰่ฃ… โ†’ ๅฏๅŠจ๏ผ‰
ngoclaw remote deploy --host 192.168.1.100 --user root --password xxx --name MyServer

# Manage remotes / ็ฎก็†่ฟœ็ซฏ
ngoclaw remote list              # List all remotes / ๆŸฅ็œ‹ๆ‰€ๆœ‰่ฟœ็ซฏ
ngoclaw remote activate MyServer # Activate remote / ๆฟ€ๆดป่ฟœ็ซฏ
ngoclaw remote remove MyServer   # Remove remote / ็งป้™ค่ฟœ็ซฏ

Supported architectures: amd64, arm64, mipsle (OpenWrt) ๆ”ฏๆŒๆžถๆž„๏ผšamd64ใ€arm64ใ€mipsle๏ผˆOpenWrt๏ผ‰

Supported init systems: systemd, procd, sysvinit, nohup fallback ๆ”ฏๆŒ init ็ณป็ปŸ๏ผšsystemdใ€procdใ€sysvinitใ€nohup ๅค‡้€‰

Once deployed, use remote_exec tool to run any tool on the remote machine. ้ƒจ็ฝฒๅŽ๏ผŒไฝฟ็”จ remote_exec ๅทฅๅ…ทๅœจ่ฟœ็ซฏๆ‰ง่กŒไปปๆ„ๅทฅๅ…ทใ€‚

๐Ÿ“ฆ Skill System / ๆŠ€่ƒฝ็ณป็ปŸ

9 skills are built-in. Create custom skills by adding a directory with SKILL.md: 9 ไธชๆŠ€่ƒฝๅ†…็ฝฎใ€‚ๅˆ›ๅปบ่‡ชๅฎšไน‰ๆŠ€่ƒฝๅช้œ€ๆทปๅŠ ็›ฎๅฝ•ๅ’Œ SKILL.md๏ผš

---
name: my-skill
description: When to use this skill
---

# My Skill
Workflow instructions here...

Auto-discovered on startup. Install community skills via npx skills find <query>. ๅฏๅŠจๆ—ถ่‡ชๅŠจๅ‘็Žฐใ€‚้€š่ฟ‡ npx skills find <query> ๅฎ‰่ฃ…็คพๅŒบๆŠ€่ƒฝใ€‚

๐Ÿ“ Project Structure / ้กน็›ฎ็ป“ๆž„

ngoclaw/
โ”œโ”€โ”€ gateway/                    # Go main program / Go ไธป็จ‹ๅบ
โ”‚   โ”œโ”€โ”€ cmd/
โ”‚   โ”‚   โ”œโ”€โ”€ cli/               # Unified binary: CLI + serve + remote mgmt + doctor
โ”‚   โ”‚   โ””โ”€โ”€ remote/            # Remote daemon (deployed to target machines)
โ”‚   โ”œโ”€โ”€ internal/
โ”‚   โ”‚   โ”œโ”€โ”€ domain/            # Domain layer (entities, services, tools) / ้ข†ๅŸŸๅฑ‚
โ”‚   โ”‚   โ”œโ”€โ”€ application/       # Application layer (app.go, usecases) / ๅบ”็”จๅฑ‚
โ”‚   โ”‚   โ”œโ”€โ”€ infrastructure/    # Infrastructure (LLM, tools, prompt, sandbox, remote) / ๅŸบ็ก€่ฎพๆ–ฝๅฑ‚
โ”‚   โ”‚   โ””โ”€โ”€ interfaces/        # Interface layer (CLI, TG, HTTP, gRPC, WS) / ๆŽฅๅฃๅฑ‚
โ”‚   โ””โ”€โ”€ go.mod
โ”œโ”€โ”€ sdk/                        # Client SDKs (Go, Python)
โ”œโ”€โ”€ shared/                     # Shared protobuf definitions
โ”œโ”€โ”€ docs/                       # Documentation / ๆ–‡ๆกฃ
โ”œโ”€โ”€ Makefile
โ””โ”€โ”€ LICENSE

๐Ÿ› ๏ธ Tech Stack / ๆŠ€ๆœฏๆ ˆ

Component / ็ป„ไปถ Technology / ๆŠ€ๆœฏ
Language / ่ฏญ่จ€ Go 1.24
HTTP Gin
Telegram telegram-bot-api/v5
TUI Bubble Tea + Lip Gloss + Glamour
Database / ๆ•ฐๆฎๅบ“ SQLite / PostgreSQL (GORM)
Logging / ๆ—ฅๅฟ— Zap
Config / ้…็ฝฎ Viper
Vector Store / ๅ‘้‡ๅญ˜ๅ‚จ LanceDB
gRPC google.golang.org/grpc

๏ฟฝ๐Ÿ“„ License / ่ฎธๅฏ่ฏ

MIT License

๐Ÿค Contributing / ่ดก็Œฎ

Contributions welcome! / ๆฌข่ฟŽ่ดก็Œฎ๏ผ

  • Architecture / ๆžถๆž„: Respect DDD layering / ้ตๅพช DDD ๅˆ†ๅฑ‚
  • Code Style / ไปฃ็ ้ฃŽๆ ผ: SOLID principles, components < 500 lines / SOLID ๅŽŸๅˆ™
  • Testing / ๆต‹่ฏ•: Add tests for new tools and services / ๆ–ฐๅŠŸ่ƒฝ่ฏท้™„ๆต‹่ฏ•
  • Commits / ๆไบค: Use conventional commit messages
  • Issues: Bug reports and feature requests via GitHub Issues
  • PRs: Fork โ†’ branch โ†’ implement โ†’ test โ†’ PR

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages