Skip to content

README.md

Latest commit

 

History

History
106 lines (87 loc) · 4.48 KB

README.md

File metadata and controls

106 lines (87 loc) · 4.48 KB
Raw

CtrlC documentation

CtrlC builds React section packs and recreation guidance from a public page you may analyze.
Not full website creation. Not HTML scraping. Default: one page's sections; multi-page only when requested.

SectionPack dual export on every section:

  1. Natural language - function, motion, behavior, layout, color, multi-file influences
  2. Code as-is - multi-file component pack (TSX + content + CSS + deps)

Public demos use the fictional Northline brand only.

Start here

Path Audience
Completed work What shipped in 0.1.x and what is still open
Guide: Getting started First install + demo
Guide: Principles Non-negotiable product rules
Guide: Responsible use Legal / ethics
Concepts: Architecture How packages fit together
Concepts: Dual export Natural language vs code packs

Reference

Path Topic
Export formats describe, prompt, zip, multi, recipes, var.*
CLI CtrlC commands
HTTP API /api/dev/section-pack
Config schema SectionPackConfig + JSON Schema

Workflows

Path Topic
Hybrid clone pipeline Ditto + AI cloner ideas → CtrlC
init-clone + register Scaffold + auto SectionPack registration
Capture → specs → register IR capture + section specs
Cloner integration Page-first React clone pipeline
Scan bootstrap Discover sections → draft config
Library export Offline agent context tree
Watch and drift Live rebuild + CI fingerprints
Scaffold apps create-ctrlc-app

Roadmap

Path Topic
Path to 1.0 0.1.x MVP → 0.5 → 1.0 priorities, gaps, version bands
Versioning 0.1.x / 0.2–0.4 / 0.5–0.8 / 1.0 bands
Distribution npm order, examples, media, publish readiness gate
API freeze policy Stable config, export formats, CLI; SemVer + changelog
Eval harness Metrics and agent/pack evaluation
Agent eval protocol Skill-run reliability + structure score ≥ 0.7
Demo media Northline-only GIF/video capture notes

Research and backlog

Path Topic
Prior art: Ditto + AI cloner What to learn; hybrid architecture
Attribution MIT study policy
Clone pipeline backlog Implementable epic/sprint list
Section spec template Contract for builders
Section builder prompt One-section agent build prompt
Parallel build Dispatch multiple section builders

Packages

Path Package
core @ctrlc/core
react @ctrlc/react
next @ctrlc/next
capture @ctrlc/capture
cli @ctrlc/cli
mcp @ctrlc/mcp

Docs layout

docs/
  README.md                 <- you are here
  guide/                    <- onboarding
  concepts/                 <- mental models
  reference/                <- APIs, formats, CLI
  workflows/                <- day-to-day / agent pipelines
  packages/                 <- per-package notes
  research/                 <- prior art + attribution
  roadmap/                  <- path to 1.0 + API freeze
  eval/                     <- metrics and harness docs
  backlog/                  <- epic status
  templates/                <- specs + builder prompts

Quick commands

cd CtrlC
npm install && npm run build
npm test && npm run test:mcp
npm run validate && npm run validate:demo
npm run ctrlc -- doctor
npm run dev:demo
# http://localhost:3040