← 返回 Skills 市场
newageinvestments25-byte

Homelab Runbook

作者 New Age Investments · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ 安全检测通过
124
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install homelab-runbook
功能描述
Scan and document all running services on this machine — Docker containers, system services (launchd/systemd), and open listening ports. Generates a human-re...
使用说明 (SKILL.md)

Homelab Runbook

Scan the host machine and generate a Markdown runbook documenting all running services.

Scripts

All scripts are in scripts/. Run with python3 \x3Cscript>. All output JSON to stdout.

Script Purpose
scan_docker.py Running containers: name, image, ports, mounts, status
scan_services.py System services via launchd (macOS) or systemd (Linux)
scan_ports.py Open TCP listening ports with process and PID
generate_runbook.py Combine all scans → formatted Markdown runbook

Generating a Runbook

Quickest — run all scanners inline and print to stdout:

python3 scripts/generate_runbook.py

Save to a file:

python3 scripts/generate_runbook.py --output ~/homelab-runbook.md

Save to workspace:

python3 scripts/generate_runbook.py --output /Users/openclaw/.openclaw/workspace/homelab-runbook.md

Pre-collect then generate (useful for cron or piping):

python3 scripts/scan_docker.py > /tmp/docker.json
python3 scripts/scan_services.py > /tmp/services.json
python3 scripts/scan_ports.py > /tmp/ports.json
python3 scripts/generate_runbook.py --docker /tmp/docker.json --services /tmp/services.json --ports /tmp/ports.json --output ~/homelab-runbook.md

Agent Workflow

When the user asks for a homelab runbook or service inventory:

  1. Run generate_runbook.py (all scanners inline, save to workspace file).
  2. Read the output file and summarize key findings:
    • How many Docker containers are running and what they are
    • Notable open ports and the processes owning them
    • Any errors or warnings (Docker not found, permission denied, etc.)
  3. Offer to save to Obsidian vault if the user wants it persisted.

Use the --output flag to write to the workspace. Do not dump the full raw Markdown at the user — summarize it and offer the file path.

Edge Cases

  • Docker not installed: scan_docker.py returns {"error": "Docker not installed or not running", "containers": []} — runbook shows a warning, continues.
  • No containers running: Returns empty list, runbook shows "No running containers."
  • Port scan permission denied: scan_ports.py returns an error — runbook shows warning. Tell the user to re-run with sudo if full port visibility is needed.
  • Linux without systemd: scan_services.py will return an error — acceptable, runbook notes it.

Customization

See references/customization.md for:

  • Excluding specific services/containers/ports
  • Adding manual service notes (URLs, config paths, restart commands)
  • Scheduling with cron
  • Modifying output format
安全使用建议
This skill is internally consistent and does what it advertises: it inventories Docker containers, system services, and listening ports and writes a Markdown runbook. Before installing or running it, consider: (1) the scans reveal potentially sensitive local information (container mounts/host paths, process names and PIDs, service descriptions) — don't share the raw runbook without review; (2) port scanning may require sudo to see all listeners; (3) the skill itself does not exfiltrate data, but an agent with network/send privileges could forward results elsewhere — only run it on machines you trust and inspect the generated runbook before persisting or sharing; (4) if you want to hide specific services/paths, use the provided customization examples before running. If you want extra assurance, review the included scripts locally (they are short and call standard system tools) or run them manually once to confirm their output.
功能分析
Type: OpenClaw Skill Name: homelab-runbook Version: 1.0.0 The homelab-runbook skill is a legitimate system inventory tool designed to document Docker containers, system services, and open ports on macOS and Linux. It gathers information using standard system utilities (docker, systemctl, lsof, ss) and aggregates the data into a Markdown report via scripts like generate_runbook.py and scan_ports.py. The code follows its stated purpose, contains no network exfiltration logic, and lacks any evidence of malicious intent or prompt injection.
能力评估
✓ Purpose & Capability
Name/description match the implementation: provided Python scanners call docker, launchctl/systemctl, ss/netstat/lsof to build an inventory and a generator creates a Markdown runbook. External binaries used are the ones needed to inspect containers, services, and ports.
ℹ Instruction Scope
SKILL.md instructs the agent to run the included scanner scripts, summarize the generated runbook, and optionally save the file to the workspace or offer to persist to an Obsidian vault. The instructions do not ask the agent to read unrelated files or secrets, but the scans intentionally enumerate potentially sensitive local information (container mounts/host paths, process names/PIDs, service descriptions).
✓ Install Mechanism
No install spec; this is instruction + included code only. The scripts run with the system Python and call local binaries. Nothing is downloaded or written to system locations by an installer.
ℹ Credentials
The skill requests no environment variables or external credentials. However, it legitimately reads local system state (processes, mount points, Docker container metadata) which can expose sensitive host paths and process ownership. Full port visibility may require elevated privileges (the code notes permission errors and suggests sudo).
✓ Persistence & Privilege
always is false and the skill does not modify other skills or system-wide agent settings. It writes runbook output only to a user-specified file or stdout. Autonomous invocation is allowed (platform default) but not combined with other concerning privileges.
如何使用
  1. 确保已安装 OpenClaw（本地或 Docker 部署）
  2. 在对话框中输入安装命令：/install homelab-runbook
  3. 安装完成后，直接呼叫该 Skill 的名称或使用 /homelab-runbook 触发
  4. 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
Initial release: Auto-document running services — Docker containers, system services (launchd/systemd), and open ports. Generates Markdown runbook.
元数据
Slug homelab-runbook
版本 1.0.0
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 1
常见问题

Homelab Runbook 是什么？

Scan and document all running services on this machine — Docker containers, system services (launchd/systemd), and open listening ports. Generates a human-re... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 124 次。

如何安装 Homelab Runbook？

在 OpenClaw 或 Claude Code 对话框中运行命令「/install homelab-runbook」即可一键安装，无需额外配置。

Homelab Runbook 是免费的吗？

是的，Homelab Runbook 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。

Homelab Runbook 支持哪些平台？

Homelab Runbook 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。

谁开发了 Homelab Runbook？

由 New Age Investments（@newageinvestments25-byte）开发并维护，当前版本 v1.0.0。

推荐 Skills
self-improving agent
Captures learnings, errors, and corrections to enable continuous improvement. Use when: (1) A command or operation fails unexpectedly, (2) User corrects Clau...
⬇ 463556 · by pskoett
Skill Vetter
Security-first skill vetting for AI agents. Use before installing any skill from ClawdHub, GitHub, or other sources. Checks for red flags, permission scope, and suspicious patterns.
⬇ 259610 · by spclaudehome
Polymarket
Query Polymarket prediction markets. Check odds, find trending markets, search events, track price movements.
⬇ 232503 · by joelchance
Self-Improving + Proactive Agent
Self-reflection + Self-criticism + Self-learning + Self-organizing memory. Agent evaluates its own work, catches mistakes, and improves permanently. Use when...
⬇ 200551 · by ivangdavila
Github
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
⬇ 191226 · by steipete
ontology
Typed knowledge graph for structured agent memory and composable skills. Use when creating/querying entities (Person, Project, Task, Event, Document), linkin...
⬇ 190235 · by oswalpalash

💬 留言讨论