| title | CARTO Workflows Extension Template | |||
|---|---|---|---|---|
| description | Template repository for creating custom extension packages for CARTO Workflows | |||
| version | 1.0.0 | |||
| last-updated | 2025-01-27 | |||
| depends-on | ||||
| tags |
|
Use this template repository as a framework for creating extension packages for CARTO Workflows, containing custom components that are tailored to your specific use cases.
These packages can be easily distributed and installed within the Workflows application, extending its core functionality with new, specialized operations.
Find more documentation about installing and managing extension packages in this section of the CARTO documentation.
Currently, Extension Packages are supported in Workflows created for BigQuery, Snowflake, and Oracle connections.
This repository contains comprehensive documentation for both human developers and AI agents.
Learn more about building, testing, and distributing extension packages:
This document describes the different elements that are needed to build an extension package and how they relate to each other.
Read it carefully to understand how inputs, settings and outputs are defined along with the logic of each component.
It also contains a description of the basic elements required to define automated tests for your component.
There are also specific pages that go in detail about some of the pieces needed to build an extension. Check them once you're familiar with the basic structure:
This section contains a step by step guide for creating your first extension package.
✅ Tests
Learn how to configure, run and automate different tests for your components.
🧰 Tools
Learn how to use the tools included with this template to help with the creation of extension packages.
This repo ships a Claude Code skill at .claude/skills/build-workflows-extension/ that autoloads when an agent is asked to build, modify, test, or package an extension. The skill is the single entry point — its SKILL.md walks the agent through the five-phase lifecycle (scaffold → metadata → SQL → tests → package/deploy) and points at deeper references on demand.
Agent-targeted reference material has been moved into the skill folder:
Quick Start:
- Quickstart Guide - Minimal 5-minute path to first component
- Quick Reference - One-page cheat sheet with patterns and commands
- Glossary - All domain terms and definitions
Reference:
- Validation Rules - Complete constraints in scannable tables
- Extension Metadata Schema - JSON Schema for validation
- Component Metadata Schema - JSON Schema for validation
Examples:
- Examples Index - Working component examples with tests
- Minimal Component - Complete working example
- Multi-Input Component - All input types
- Conditional Inputs - ShowIf patterns
Patterns:
- Template SQL (Annotated) - Heavily commented fullrun.sql and dryrun.sql explaining patterns
Navigation Tips for Agents:
- Start at
SKILL.md— it indexes everything else - Reference JSON Schemas for metadata validation
- Use the Quick Reference for fast lookups during edits