Skip to content

upioneer/code-scaffold

Repository files navigation

Code Scaffold

GitHub stars GitHub forks GitHub issues GitHub pull-requests GitHub contributors GitHub last commit

Code Scaffold is a modular, robust, and highly visual native TUI provisioning engine (built in Rust with Ratatui). It is designed to bootstrap new development projects with predefined directory structures, architectural templates, and complex skill payloads, all driven by a high-fidelity Terminal User Interface.

Code Scaffold Screenshot 1

Features

  • High-Fidelity TUI: A deeply interactive, color-coded terminal interface featuring animated ASCII branding, staggered visual loading, and clean category-based module selection.
  • Remote Synchronization Engine: Capable of dynamically fetching the latest manifest.json from the remote GitHub repository. If an update is detected, it automatically downloads and caches the latest .templates and .skills payloads before execution.
  • Intelligent Environment Detection: Detects if it is running in "Local Dev" mode (within the core repository) to preserve source files, or in "Production" mode where it uses a secure temporary workspace ($env:TEMP\Scaffold_Workspace).
  • Dynamic Payload Library: Easily extensible. By placing a new folder with a meta.json inside the .skills directory, the engine will automatically discover it and present it as an option in the UI.
  • Secure Provisioning: Automatically generates a stringent .gitignore for standard security policies, and in production mode, the engine acts as a self-destructing bootstrapper.
  • Automated Baseline Documentation: Automatically generates a structured README.md in the target directory, dynamically titled with the project's folder name, to provide a consistent starting point for all scaffolded projects.
  • Immutable Version History: Adheres to a strict versioning protocol, maintaining snapshots of every significant deployment cycle in project_details\history.

Code Scaffold Screenshot 2

Architecture Overview

The system operates on a dual-layer architecture:

  1. The Core Engine (code-scaffold): The native Rust TUI executable that handles the sync engine, user interface rendering, and file provisioning logic. (Note: The legacy scaffold.ps1 bootstrapper is deprecated).
  2. The Payload Library (.skills & .templates): Hidden directories containing raw source code and Markdown files. Each skill subdirectory must contain a strict meta.json file schema:
{
  "label": "The UI display name",
  "description": "A brief explanation of the payload",
  "version": "1.0.0",
  "target": "The exact relative path where this payload should be deployed e.g. .skills/supabase"
}

Usage

Run the native executable from your terminal (e.g., on Windows):

.\code-scaffold.exe

(Note: The legacy scaffold.ps1 bootstrapper is deprecated).

  1. Target Selection: The engine will prompt you for a target directory. Leave it blank to use the current directory.
  2. Module Selection: Navigate the menu using the [Up/Down Arrow] keys.
  3. Shortcuts:
    • [Space]: Toggle individual selection (prompts to overwrite if the artifact already exists).
    • [T]: Toggle All/None selections (prompts to overwrite if any selected artifacts already exist).
  4. Execution: Press [Enter] to begin the provisioning process.

Built-In Scaffolding Options

  • Core Applications: /src, /tests, /docs
  • Artifacts: Boilerplate markdown files (AGENT.md, DESIGN.md, PLAN.md, README.md, etc.) automatically routed to project_details (except README and LICENSE).
  • Agent Skills: Pre-configured integration snippets (Braille Animations, Clerk Authentication Perimeter, Excalidraw, Firebase, Firecrawl, GitHub, Hyperframes, Manim, Marp, Mermaid, Node, Open Design, OpenCLI, p5.js, PlayCanvas Editor, PlayCanvas Engine, PlayCanvas SuperSplat, Playwright, Ratatui, Resend, SEO GEO AEO Auditor, Supabase, Telegram, Trackio ML Tracking, Upstash Redis Management, Vercel Deployment Routine, Website Deploy Linux) deployed to their designated target paths.

Agent Skills Library

Code Scaffold features a rapidly growing library of specialized AI skills. For a complete list of available payloads, detailed descriptions, and their target deployment paths, please refer to the Agent Skills Library.