Guide

Agent skill

Station ships with a Claude Code skill that teaches the AI assistant how to build with every Station package. Once installed, Claude knows how to create signals, broadcasts, adapters, runners, subscribers, and dashboard configs without you having to explain the API.


What is a skill?

A Claude Code skill is a set of markdown files that get injected into Claude’s context when relevant. Skills contain API references, code patterns, and rules that guide the assistant’s output. The Station skill covers all seven packages and the REST API.


Install

npx skills add porkytheblack/station

The skill directory contains three files:

FileDescription
SKILL.mdMain skill file. Contains critical rules, code patterns, builder method tables, subscriber events, and design principles. This is what Claude reads first.
api-reference.mdExhaustive API reference for all seven packages: station-signal, station-broadcast, station-adapter-sqlite, station-adapter-postgres, station-adapter-mysql, station-adapter-redis, and station-kit. Also covers the Station v1 REST API.
examples.mdSeventeen complete, copy-pasteable examples covering basic signals, multi-step pipelines, recurring jobs, broadcasts, remote triggers, all four adapter backends, and a full project structure template.

Usage

Once installed, the skill activates automatically when you ask Claude about Station topics. You can also invoke it explicitly:

/station

Example prompts that trigger the skill:


What the skill knows

TopicCoverage
SignalsBuilder chain (.input(), .output(), .timeout(), .retries(), .every(), .onComplete(), .run()), multi-step pipelines (.step() + .build()), triggering, validation
BroadcastsDAG builder (.node(), .then()), conditional nodes (when), failure policies, input/output mapping, fan-out and fan-in patterns
AdaptersAll four backends (SQLite, PostgreSQL, MySQL, Redis) for both signals and broadcasts. Constructor patterns, connection options, subpath imports
RunnersSignalRunner and BroadcastRunner setup, auto-discovery, manual registration, graceful shutdown, poll intervals
SubscribersAll lifecycle events for both signal and broadcast runners. Custom subscriber patterns for logging, metrics, and alerting
Remote triggersconfigure({ endpoint, apiKey }), HttpTriggerAdapter, environment variables, Station REST API endpoints
Dashboardstation.config.ts options, CLI usage, auth configuration

Updating

Re-run the install command to pull the latest version:

npx skills add porkytheblack/station