scafscaf
KitDocs

Documentation

Install the kit

  1. 1

    Download the kit archive and unzip it.

  2. 2

    Put the _agent-kit folder in scaf/ at the root of your project.

  3. 3

    Add the kit's agent block to AGENTS.md or CLAUDE.md.

  4. 4

    Check with the audit: ruby scaf/_agent-kit/tools/audit.rb scaf/v0.

Use the kit

Read README, structure, formats then rules; then the skill matching your task.

Kit skills

Summary: the full skills are in the kit archive. See the repository ↗

  • scaf-add-structure

    Add, rename or remove an app, module or feature.

  • scaf-audit-consistency

    Audit a version's consistency and fix the gaps.

  • scaf-check-mocks

    Check that mocks match their spec, enums included.

  • scaf-database-visual

    Model the data (tables, keys, indexes, enums) from the endpoints.

  • scaf-generate-nestjs

    Generate the NestJS API from the specification.

  • scaf-generate-openapi

    Generate per-app OpenAPI from the contracts.

  • scaf-update-kit

    Update the kit from the official repository, on request.

  • scaf-version-fork

    List, fork, activate or compare a project's versions.

  • scaf-write-constraints

    Frame an app or feature with verifiable rules.

  • scaf-write-consumer-usecase

    Describe how a client app calls an endpoint.

  • scaf-write-endpoint-contract

    Write an endpoint: method, path, inputs, outputs, errors.

  • scaf-write-enums

    Unify enumerations across all apps.

  • scaf-write-export-config

    Configure target app generation (Next.js, NestJS).

  • scaf-write-intent

    Explain why an endpoint exists and who calls it.

  • scaf-write-journey

    Break a business question into a step-by-step journey.

  • scaf-write-mocks

    Write the mocks: nominal, errors, edge cases.

  • scaf-write-usecase

    Write a usecase: inputs, outputs, steps, errors.

SCAF · Specify the app, generate the rest

Designed and built by Saazh Al-Ba'Hith BN ↗

GitHub ↗