# Where to Find text-to-CAD Documentation: Complete Guide to earthtojake/text-to-cad

> Find text-to-CAD documentation easily. Explore web docs, in-repo Markdown files, and the README for comprehensive guides and installation instructions for earthtojake/text-to-cad.

- Repository: [earthtojake/text-to-cad](https://github.com/earthtojake/text-to-cad)
- Tags: documentation
- Published: 2026-08-02

---

**text-to-CAD documentation is available through three main channels: the official web docs at cadskills.xyz, in-repository Markdown skill files like [`skills/cad/SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/skills/cad/SKILL.md), and the root [`README.md`](https://github.com/earthtojake/text-to-cad/blob/main/README.md) that provides high-level overviews and installation instructions.**

The `earthtojake/text-to-cad` repository converts natural language into programmable CAD models through a modular skill system. Understanding where to find authoritative text-to-CAD documentation ensures you can leverage the CLI tools, Python APIs, and viewer components effectively. All documentation is version-controlled in the repository and rendered to the web site automatically, guaranteeing consistency between online guides and local source files.

## Official Web Documentation

The primary entry point for browsing documentation is the rendered site at **[https://www.cadskills.xyz](https://www.cadskills.xyz)**. This web interface aggregates skill reference manuals, usage guides, and workflow tutorials into a searchable format. Because the site is generated directly from the repository's Markdown files, you can rely on the web docs to reflect the current state of the `main` branch.

## In-Repository Skill References

Each capability in the text-to-CAD ecosystem ships with a dedicated [`SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/SKILL.md) file describing its purpose, CLI commands, and assumptions. These files constitute the authoritative source for how individual components operate.

### CAD Skill Reference

The core modeling functionality is documented in **[`skills/cad/SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/skills/cad/SKILL.md)**. This file details how to generate STEP models from Python scripts using build123d, manage part assemblies, and handle geometric references. It includes the command signatures for `scripts/step`, `scripts/inspect`, and `scripts/snapshot` utilities.

### CAD-Viewer Skill Reference

For visualization and interactive model inspection, reference **[`skills/cad-viewer/SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/skills/cad-viewer/SKILL.md)**. This document explains how to launch the web-based viewer, load local STEP or GLB files, and configure the rendering environment.

### Additional Robotics and Manufacturing Skills

The repository includes specialized skills for robotics and 3D printing workflows:

- **[`skills/urdf/SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/skills/urdf/SKILL.md)** – URDF generation and validation for robot descriptions
- **[`skills/srdf/SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/skills/srdf/SKILL.md)** – Semantic robot description format support  
- **[`skills/sdf/SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/skills/sdf/SKILL.md)** – Simulation description format handling
- **G-code and Bambu Labs skills** – Located in corresponding subdirectories under `skills/`

## Root README and Package Documentation

The **[`README.md`](https://github.com/earthtojake/text-to-cad/blob/main/README.md)** at the repository root provides the high-level architectural overview, a complete table of available skills, badge links to the live demo, and quick-start installation instructions.

For Python developers, two package-specific README files offer API documentation:

- **[`packages/cadpy/README.md`](https://github.com/earthtojake/text-to-cad/blob/main/packages/cadpy/README.md)** – Documents the `cadpy` library for STEP, STL, and GLB handling, including the `load_step()` function and bounds inspection methods
- **[`packages/implicitjs/README.md`](https://github.com/earthtojake/text-to-cad/blob/main/packages/implicitjs/README.md)** – Covers the browser-native implicit CAD library that powers the web viewer's computational geometry

## Practical CLI and API Examples

Install the library globally using the Skills CLI:

```bash
npx skills install earthtojake/text-to-cad

```

Generate a STEP model from a build123d Python script:

```bash
python scripts/step my_part.py --kind part

```

Inspect geometric properties and reference planes of the generated file:

```bash
python scripts/inspect refs my_part.step --facts --planes

```

Create a visual snapshot for documentation or review:

```bash
python scripts/snapshot my_part.step

```

Launch the CAD Viewer for interactive model inspection:

```bash
cad-viewer --file /absolute/path/to/models/my_part.step

```

Access STEP files programmatically via the Python API:

```python
from cadpy import load_step
model = load_step("my_part.step")
print(model.bounds())

```

## Summary

- **Web Documentation**: Browse [cadskills.xyz](https://www.cadskills.xyz) for rendered, searchable guides generated from repository sources
- **Skill References**: Consult [`SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/SKILL.md) files in `skills/cad/`, `skills/cad-viewer/`, and other skill directories for CLI details and workflow assumptions  
- **Repository Overview**: Check the root [`README.md`](https://github.com/earthtojake/text-to-cad/blob/main/README.md) for installation, architecture overviews, and the complete skill inventory
- **Package APIs**: Reference [`packages/cadpy/README.md`](https://github.com/earthtojake/text-to-cad/blob/main/packages/cadpy/README.md) and [`packages/implicitjs/README.md`](https://github.com/earthtojake/text-to-cad/blob/main/packages/implicitjs/README.md) for Python and JavaScript library usage
- **Synchronized Sources**: The web docs and repository files are kept in sync, ensuring version-controlled documentation is always authoritative

## Frequently Asked Questions

### Is the web documentation generated from the repository files?

Yes. The site at cadskills.xyz renders directly from the Markdown files stored in the repository, ensuring that the web documentation and version-controlled sources remain identical. When you view [`skills/cad/SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/skills/cad/SKILL.md) on GitHub or cadskills.xyz, you are seeing the same content rendered differently.

### Where can I find the CLI reference for the CAD skill?

The definitive CLI reference resides in **[`skills/cad/SKILL.md`](https://github.com/earthtojake/text-to-cad/blob/main/skills/cad/SKILL.md)**, which documents commands like `python scripts/step` for STEP generation and `python scripts/inspect` for geometric analysis. This file also explains required arguments such as `--kind part` and output format assumptions.

### How do I install the text-to-CAD library locally?

Use the Skills package manager to install the repository: `npx skills install earthtojake/text-to-cad`. This command pulls the latest version and configures the CLI tools including `cad-viewer` and the Python scripts located in the `scripts/` directory.

### What is the difference between the cadpy and implicitjs packages?

**`cadpy`** (documented in [`packages/cadpy/README.md`](https://github.com/earthtojake/text-to-cad/blob/main/packages/cadpy/README.md)) provides Python utilities for loading and manipulating mesh and STEP data, including the `load_step()` function. **`implicitjs`** (documented in [`packages/implicitjs/README.md`](https://github.com/earthtojake/text-to-cad/blob/main/packages/implicitjs/README.md)) is a browser-native implicit CAD library that enables real-time geometric computation in the CAD Viewer without server round-trips.