project-scaffold
ProjectScaffold
Scaffold a new CLEF project named $ARGUMENTS with the standard directory layout, example concept, and configuration files.
When to use: Use when starting a new CLEF project from scratch. Creates the standard directory structure, example concept spec, and configuration files.
Design Principles
- Minimal Viable Structure: Scaffold the minimum needed to run
clef checkandclef generate— don't overload with unused templates. - Convention Over Configuration: Project follows standard directory layout (specs/, syncs/, implementations/) so tools work without configuration.
Step-by-Step Process
Step 1: Scaffold New Project
Create a new Clef project directory with specs , syncs , implementations , and configuration files . Generates an example concept and sync to get started .
Arguments: $0 name (string)
Checklist:
- Project name is valid (kebab-case, no conflicts)?
- Directory structure created correctly?
- Example concept spec is parseable?
- Configuration files have sensible defaults?
Examples: Scaffold a new project
clef init my-app
Scaffold with custom template
clef init my-app --template minimal
References
Supporting Materials
Quick Reference
| Directory | Purpose | Contains |
|---|---|---|
| specs/ | Concept specifications | .concept files |
| syncs/ | Synchronization rules | .sync files |
| implementations/ | Handler code | .handler.ts files |
| suites/ | Suite manifests | suite.yaml + concepts + syncs |
Validation
Validate scaffolded project:
npx tsx cli/src/index.ts check
Related Skills
| Skill | When to Use |
|---|---|
/concept-designer |
Design concepts for the new project |
/suite-lifecycle |
Bundle concepts into reusable suites |
/dev-workflow |
Start the dev server for the new project |
More from itshalffull/concept-oriented-programming-framework
surface-component-scaffold-gen
Generate Clef Surface headless component scaffolds including widget specifications with anatomy , state machines , accessibility , affordance bindings , props , connect mappings , compose declarations , and invariants . Follows the Zag . js Ark UI pattern where behavior and rendering agree on part names
1surface-theme-scaffold-gen
Generate Clef Surface design system theme scaffolds including palette ( oklch color scales ) , typography ( modular ratio ) , spacing tokens , motion definitions ( with reduced motion ) , elevation scale , radius tokens , and light dark theme manifests . Supports theme extension via extends . Follows WCAG accessibility guidelines for contrast ratios
1