AgentSkillsCN

tscircuit-docs

为使用 TypeScript/React 设计 PCB 提供全面的 tscircuit 文档支持。适用于 tscircuit 组件、封装库、CLI 命令、Web API 的开发工作,或用于学习 tscircuit 的工作流。内容涵盖安装指南、48 种以上组件类型、封装规格、tsci CLI 参考文档、编程式 API、SPICE 仿真、KiCad 集成,以及项目教程。

SKILL.md
--- frontmatter
name: tscircuit-docs
description: Comprehensive tscircuit documentation for designing PCBs with TypeScript/React. Use when working with tscircuit components, footprints, CLI commands, web APIs, or learning tscircuit workflows. Covers installation, 48+ component types, footprint specs, tsci CLI reference, programmatic APIs, SPICE simulation, KiCad integration, and project tutorials.

tscircuit Documentation Reference

tscircuit is a TypeScript-first PCB design platform using React-like syntax. This skill provides complete documentation reference.

Quick Navigation

ReferenceWhen to Use
getting-started.mdInstallation, first board, project setup
cli-commands.mdtsci CLI: init, dev, build, export, search, add, push
components.md48+ component types: chip, resistor, trace, etc.
footprints.mdFootprint specs, KiCad integration, custom footprints
apis.mdCompile, autorouting, datasheet, ordering APIs
guides.mdEssentials, importing, running, SPICE, KiCad
tutorials.mdUSB flashlight, LED matrix, keyboard, Pi HAT
advanced.mdAI context, local dev, math utils, units
contributing.mdContributor guide, bounties, project overview

Quick Start

tsx
import React from "react"
import { board, resistor, capacitor, trace } from "tscircuit"

export default () => (
  <board width="10mm" height="10mm">
    <resistor resistance="1k" footprint="0402" name="R1" />
    <capacitor capacitance="100nF" footprint="0402" name="C1" />
    <trace from=".R1 > .pin1" to=".C1 > .pin1" />
  </board>
)

CLI Quick Reference

bash
tsci init          # Initialize project
tsci dev           # Dev server with preview
tsci build         # Build circuit JSON
tsci export -f pcb-svg  # Export to SVG
tsci search resistor     # Search footprints
tsci add author/pkg      # Install package

Key Concepts

  • Board: Root element containing all components
  • Components: Resistors, capacitors, chips, etc. with footprints
  • Footprints: Physical pad layouts (0402, 0805, soic8, qfn32)
  • Traces: Copper connections between component pins
  • Nets: Logical connections (net.VCC, net.GND)

Common Patterns

Chip with Connections

tsx
<chip
  name="U1"
  footprint="soic8"
  pinLabels={{ pin1: "VCC", pin2: "GND", pin3: "IN", pin4: "OUT" }}
  connections={{ VCC: "net.VCC", GND: "net.GND" }}
/>

Layout Positioning

tsx
<resistor
  name="R1"
  resistance="1k"
  footprint="0402"
  pcbX={3} pcbY={2}        // PCB position
  schX={5} schY={3}        // Schematic position
/>

Resources