Documentation Index
Fetch the complete documentation index at: https://docs.goldsky.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Goldsky Agent is a skill pack for AI coding assistants that helps you build, deploy, and debug Turbo pipelines that stream real-time blockchain data from 130+ chains into PostgreSQL, ClickHouse, Kafka, and more.
Skills auto-trigger based on what you describe — no slash commands required. Interactive workflow skills walk you through multi-step tasks end-to-end. Reference skills provide YAML syntax, error patterns, and CLI commands on demand.
Works with Claude Code, Cursor, Windsurf, OpenCode, Codex, and other AI coding assistants.
Quick Start
| I want to… | Use |
|---|
| Build a new pipeline | /turbo-builder |
| Fix a broken pipeline | /turbo-doctor |
| Find the right dataset name | /datasets |
| Look up YAML syntax | /turbo-pipelines |
| Check error patterns | /turbo-operations |
Installation
npx (recommended)
Claude Marketplace
Claude Code (local)
Cursor (local)
Manual
Installs to Claude Code, Cursor, and 30+ other AI agents:npx skills add goldsky-io/goldsky-agent
/plugin marketplace add goldsky-io/goldsky-agent
/plugin install goldsky@goldsky-agent
git clone https://github.com/goldsky-io/goldsky-agent.git
claude --plugin-dir ./goldsky-agent
Clone the repo and add the path to Cursor settings (Settings > Cursor Settings > JSON):git clone https://github.com/goldsky-io/goldsky-agent.git
{
"plugins.local": ["/absolute/path/to/goldsky-agent"]
}
git clone https://github.com/goldsky-io/goldsky-agent.git
cp -r goldsky-agent/skills/* .claude/skills/ # Claude Code
cp -r goldsky-agent/skills/* .cursor/skills/ # Cursor
Available skills
Interactive skills
These guide you through multi-step tasks end-to-end:
| Skill | When to use | What it does |
|---|
turbo-builder | ”I want to build a pipeline for X” | Guides you through chain → dataset → transforms → sink → validate → deploy |
turbo-doctor | ”My pipeline is broken / not getting data / output looks wrong” | Diagnoses the problem step-by-step and offers to run fixes |
auth-setup | ”How do I install the CLI / log in?” | Walks through CLI installation, login, and project switching |
secrets | ”How do I create credentials for PostgreSQL / ClickHouse?” | Guides you through creating and managing sink credentials |
Reference skills
Look up syntax, rules, and examples without a guided workflow:
| Skill | When to use | What’s inside |
|---|
turbo-pipelines | ”What’s the YAML syntax for X?” | Complete source/transform/sink field reference |
turbo-transforms | ”How do I decode EVM logs / write a SQL transform?” | SQL, TypeScript/WASM, dynamic tables, HTTP handlers |
turbo-operations | ”How do I view logs? What does this error mean? How do I pause / restart / delete?” | CLI commands, log flags, error patterns, lifecycle commands (pause/resume/restart/delete), streaming vs job-mode |
datasets | ”What’s the dataset name for Polygon NFTs?” | Chain prefixes, dataset types, naming conventions |
cli-reference | Consulted automatically before any goldsky command | All valid subcommands, arguments, and flags — generated from the installed CLI |
How it works
Skills are automatically discovered by your AI assistant and triggered based on what you describe. You don’t need to invoke them by name.
User: "Build me a pipeline for USDC transfers on Base"
↓
turbo-builder (auto-triggered)
↓ references
turbo-pipelines + datasets + secrets
↓
Generated pipeline.yaml + deployment
turbo-builder, turbo-doctor) run as agents with access to CLI tools. Reference skills provide structured knowledge that the AI uses to answer questions or generate YAML.
Repository structure
goldsky-agent/
├── skills/
│ ├── turbo-builder/ # Step-by-step pipeline creation wizard
│ ├── turbo-doctor/ # Diagnose and fix pipeline issues
│ ├── turbo-pipelines/ # YAML configuration reference
│ ├── turbo-transforms/ # SQL, TypeScript, dynamic tables
│ ├── turbo-operations/ # Lifecycle, monitoring, error patterns
│ ├── datasets/ # Chain prefixes, dataset types
│ ├── secrets/ # Credential management
│ ├── auth-setup/ # CLI installation, login
│ └── cli-reference/ # Valid CLI commands + flags (auto-generated)
├── scripts/
│ └── generate-cli-reference.sh # Regenerates cli-reference from installed CLI
├── hooks/
│ └── scripts/ # Validation, secret checking
└── .claude-plugin/ # Plugin manifest
Pre-deploy hooks
When installed as a plugin, Goldsky Agent runs hooks automatically on goldsky turbo apply commands:
| Hook | What it does |
|---|
pre-deploy-validate | Runs goldsky turbo validate, blocks on failure |
secret-check | Verifies all secret_name references exist |
post-deploy-inspect | Suggests goldsky turbo inspect after deploy |
Coverage
These skills cover the full Turbo pipeline surface:
- Sources — 130+ chains (EVM, Solana, Bitcoin, Stellar, Sui, NEAR, Starknet), source filtering, bounded ranges
- Transforms — SQL, TypeScript/WASM, dynamic tables, HTTP handlers
- Sinks — PostgreSQL, ClickHouse, Kafka, S3, Webhook, S2
- Modes — Streaming (continuous) and Job (batch with bounded sources)
- Lifecycle — Deploy, pause, resume, restart, delete
- Monitoring — Live inspect TUI, log analysis, error matching
Example prompts
Once installed, describe what you need in natural language:
- “Build a Turbo pipeline to track USDC transfers on Base”
- “My pipeline is stuck in error state — help me fix it”
- “What’s the dataset name for Polygon ERC-20 transfers?”
- “Show me the YAML syntax for a ClickHouse sink”
- “Configure a PostgreSQL secret for my pipeline”
- “Set up the Goldsky CLI and authenticate”
