skills.rest
cartography-cncf
cartography-cncfOFFICIAL
Explore all skills by this author →
GitHub

create-module

Scaffold a complete Cartography intel module with sync pattern and tests.

4.0k|550|Updated Feb 27, 2019
Search Tags:#documentation#scaffolding#ingestion#integration-testing#module#cartography#sync-pattern
One-click install
npx skills add https://github.com/cartography-cncf/cartography --skill create-module-cartography-cncf
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-module
Source: https://github.com/cartography-cncf/cartography/tree/main/.agents/skills/create-module
Command: npx skills add https://github.com/cartography-cncf/cartography --skill create-module-cartography-cncf

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Author a complete Cartography intel module end-to-end from entry point through GET/TRANSFORM/LOAD/CLEANUP, including declarative data model, integration test, and schema/docs.

Core Features & Use Cases

  • Scaffold the module structure (intel/your_service, models, tests, references) and provide a runnable integration test scaffold.
  • Implement the standard sync pattern (GET -> TRANSFORM -> LOAD -> CLEANUP) and leverage GraphJob for cleanup.
  • Wire CLI + Config wiring and register the module in cartography.sync using a lazy-loading pattern, enabling on-demand SDK loading and minimal startup overhead.
  • Produce schema docs and tests to validate end-to-end ingestion for new providers or services.

Quick Start

Execute the create-module skill to scaffold a complete Cartography intel module, including entry point, sync pattern, data model, tests, and docs.

Frequently Asked Questions about create-module

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold a Cartography intel module for a new service ingestion?▼

Scaffolding a Cartography intel module generates the complete directory structure including entry point, declarative data models, integration tests, and schema documentation for new service ingestion end-to-end.

What is the standard sync pattern for Cartography data ingestion?▼

The standard Cartography sync pattern follows a GET, TRANSFORM, LOAD, and CLEANUP sequence to retrieve, shape, persist, and clean up data using GraphJob for cleanup during ingestion workflows.

How do I register a new Cartography module in cartography.sync?▼

Register a Cartography module in cartography.sync by wiring CLI and config connections using a lazy-loading pattern, which enables on-demand SDK loading and minimizes startup overhead.

Does scaffolding a Cartography integration module include integration tests?▼

Yes, scaffolding a Cartography integration module includes a runnable integration test scaffold and schema docs to validate end-to-end ingestion for new providers or services.

What do I need to generate a complete Cartography data model and schema docs?▼

You need a new provider, integration, or service ingestion requirement to generate a complete Cartography data model and schema docs, which applies the standard sync workflow and required tests.

Related Skills

Explore More Software Engineering Skills→
cartography-cncfcartography-cncf
4.0k

create-rule

Compose Cypher Facts with a Pydantic Finding model to define Cartography security rules.

Official
Advanced
jamescha-earleyjamescha-earley

dynamic-tables

Automate declarative data pipelines with Snowflake Dynamic Tables.

Community
Advanced
GrimblazGrimblaz
3

terminal-hygiene

Enforce deterministic terminal modes, cleanup, and retry hygiene in Pester-based workflow runs.

Community
Advanced
cartography-cncfcartography-cncf
4.0k

refactor-legacy

Migrate legacy Cartography Cypher modules to load() with GraphJob.from_node_schema().

Official
Advanced