home / skills / openclaw / skills / gohome

gohome skill

/skills/local/gohome

This skill helps you test and operate GoHome via gRPC discovery, metrics validation, and Grafana integration for reliable observability.

npx playbooks add skill openclaw/skills --skill gohome

Review the files below or copy the command above to add this skill to your agents.

Files (2)
SKILL.md
1.2 KB
---
name: gohome
description: Use when Moltbot needs to test or operate GoHome via gRPC discovery, metrics, and Grafana.
metadata: {"moltbot":{"nix":{"plugin":"github:joshp123/gohome","systems":["x86_64-linux","aarch64-linux"]},"config":{"requiredEnv":["GOHOME_GRPC_ADDR","GOHOME_HTTP_BASE"],"example":"config = { env = { GOHOME_GRPC_ADDR = \"gohome:9000\"; GOHOME_HTTP_BASE = \"http://gohome:8080\"; }; };"},"cliHelp":"GoHome CLI\n\nUsage:\n  gohome-cli [command]\n\nAvailable Commands:\n  services   List registered services\n  plugins    Inspect loaded plugins\n  methods    List RPC methods\n  call       Call an RPC method\n  roborock   Manage roborock devices\n  tado       Manage tado zones\n\nFlags:\n  --grpc-addr string   gRPC endpoint (host:port)\n  -h, --help           help for gohome-cli\n"}}
---

# GoHome Skill

## Quick start

```bash
export GOHOME_HTTP_BASE="http://gohome:8080"
export GOHOME_GRPC_ADDR="gohome:9000"
```

## CLI

```bash
gohome-cli services
```

## Discovery flow (read-only)

1) List plugins.
2) Describe a plugin.
3) List RPC methods.
4) Call a read-only RPC.

## Metrics validation

```bash
curl -s "${GOHOME_HTTP_BASE}/gohome/metrics" | rg -n "gohome_"
```

## Stateful actions

Only call write RPCs after explicit user approval.

Overview

This skill lets Moltbot test and operate GoHome services using gRPC discovery, HTTP metrics, and Grafana-ready telemetry. It provides discovery flows to enumerate plugins, inspect RPCs, and execute read-only calls, plus quick checks for Prometheus-style metrics. Use it to validate service health and to prepare safe, consented stateful operations.

How this skill works

The skill uses environment-configured endpoints to connect to GoHome over HTTP and gRPC. It enumerates plugins, describes plugin interfaces, lists RPC methods, and executes read-only RPCs for safe inspection. Metrics are fetched from the GoHome HTTP metrics endpoint and filtered for GoHome-specific counters to validate telemetry.

When to use it

  • Validate GoHome service availability and plugin discovery before deeper testing.
  • Audit available RPC methods and inspect plugin descriptions in a live environment.
  • Quickly check Prometheus-style metrics for GoHome-specific metrics.
  • Prepare for approvals by enumerating write-capable RPCs before any state-changing action.
  • Integrate checks into CI pipelines that require service-level discovery and metrics validation.

Best practices

  • Set GOHOME_HTTP_BASE and GOHOME_GRPC_ADDR environment variables to target the correct instance.
  • Restrict automated calls to read-only RPCs; require explicit user approval for any write operations.
  • Use the CLI to list services and plugins before invoking RPCs to avoid unexpected side effects.
  • Fetch and filter the /gohome/metrics endpoint for keys prefixed with gohome_ to verify telemetry.
  • Combine discovery outputs with Grafana dashboards for visual validation of health signals.

Example use cases

  • Run a discovery session to list plugins and available RPCs after deploying a new GoHome version.
  • Automate a health check that curls the metrics endpoint and asserts presence of gohome_* metrics.
  • Inspect a plugin's read-only RPCs to extract configuration or status details without modifying state.
  • Prepare a change request by enumerating write RPCs and documenting required approvals before execution.
  • Integrate into an operator workflow that needs to map RPCs to Grafana panels and alerts.

FAQ

What environment variables are required?

Set GOHOME_HTTP_BASE to the HTTP base URL and GOHOME_GRPC_ADDR to the gRPC address.

Can the skill perform write operations?

Yes, but only after explicit user approval; default flows execute read-only RPCs to avoid side effects.