tscircuit-docs

Consolidate tscircuit documentation into navigable Markdown references.

Updated Feb 5, 2026
One-click install
npx skills add https://github.com/detroittommy879/tscircuit-skills --skill tscircuit-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tscircuit-docs
Source: https://github.com/detroittommy879/tscircuit-skills/tree/main/.agent/skills/tscircuit-docs
Command: npx skills add https://github.com/detroittommy879/tscircuit-skills --skill tscircuit-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a centralized, accessible reference for the tscircuit documentation, enabling users to quickly locate installation steps, component and footprint details, CLI references, APIs, SPICE guides, KiCad integration tips, and project tutorials.

Core Features & Use Cases

  • Complete Documentation: Covers getting started, 48+ component types, footprints, and workflow guides.
  • Structured References: Navigable guides under references/ (getting-started.md, cli-commands.md, components.md, footprints.md, apis.md, guides.md, tutorials.md, advanced.md, contributing.md).
  • Onboarding & Learning: Ideal for new users, developers, and reviewers to learn the tscircuit workflow and APIs.

Quick Start

Open the references directory to explore the documentation (e.g., references/getting-started.md). You may also browse references/apis.md and references/cli-commands.md for API and CLI usage.

Frequently Asked Questions about tscircuit-docs

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

FAQPage Schema
How do I get started with tscircuit for designing PCBs in TypeScript?

The tscircuit documentation provides a complete reference for designing PCBs using TypeScript and React. It includes installation steps, component footprints, APIs, and workflow tutorials to help you build circuit boards programmatically.

Can I use tscircuit with KiCad for PCB design integration?

Yes, tscircuit supports KiCad integration. The documentation includes specific tips and guides to connect your TypeScript and React PCB workflows with KiCad for cross-tool design processes.

What components and footprints are available in the tscircuit library?

The tscircuit documentation details 48+ component types and their corresponding footprints. You can browse the components and footprints references to find specific parts for your PCB designs.

How do I use the tscircuit CLI for PCB project automation?

The documentation provides a dedicated cli-commands.md reference for the tscircuit CLI. You can use these commands to automate PCB project workflows, manage components, and execute design tasks from the terminal.

Does tscircuit support SPICE simulation guides for circuit analysis?

Yes, the tscircuit documentation includes SPICE guides. These references help you simulate and analyze the behavior of your TypeScript-defined circuits before finalizing your PCB layout.

Are there tutorials for building full tscircuit workflows from start to finish?

Yes, the documentation includes a tutorials.md reference with structured guides. These provide step-by-step instructions for building complete tscircuit workflows, suitable for self-guided learning and design reviews.