Pragmatik

Pragmatik is a reusable documentation and workflow template library for AI-assisted software projects.

The goal is to standardize how projects define agent behavior, documentation rules, snapshots, versioning, naming, and repeatable delivery workflows.

Pragmatik also ships a project CLI:

npx @mvuljevas/pragmatik help
npx @mvuljevas/pragmatik setup
npx @mvuljevas/pragmatik dashboard

When installed as a project dependency, use the pragmatik command directly.

Purpose

This repository provides reusable templates for projects such as:

• Laravel + React applications, aligned with the Prisma project workflow.
• React, Vite, SPA, or PWA applications.
• Chrome extensions built with vanilla HTML, CSS, and JavaScript.
• Documentation-only repositories.
• Future project types with their own stack-specific rules.

Every template should help a user clone or copy a project foundation, then start with an analysis request such as:

Analiza el repo.
Analyze this repository.
Review the project structure.
Inspect the repo and tell me where we are.
What is the current state of this project?

The agent should interpret these as equivalent requests to inspect the repository, read its governance files, understand the current state, and then ask a project-start question such as:

¿Que vamos a construir hoy?
What are we building today?
What should we work on next?

If the repository is already in development, the agent should explain how to adopt the rules without overwriting existing project decisions.

Base Structure

README.md
AGENTS.md
LICENSE
VERSION

docs/
  AI_CONTEXT.md
  AI_SEARCH.md
  AI_TOKEN_BUDGET.md
  CATALOG.md
  CONVENTIONS.md
  NAMING.md
  ROADMAP.md
  WORKFLOWS.md
  SNAPSHOTS.md
  TECHDEBT.md

Reusable project templates live under templates/, grouped by project type. Templates are Pragmatik shells, not complete generated applications. They provide governance, minimal project docs, ignores, and setup context; real application files are created after the user describes what should be built.

Reusable workflow modules should live under presets/. Presets are not full projects; they are reusable layers that templates can adopt.

Shared Standards

All templates in this repository should share:

• Agent workflow rules.
• Snapshot rules.
• Documentation update rules.
• Git workflow and branch naming.
• Semantic Versioning for releases.
• Coherent X.Y.Z project versions.
• Matching vX.Y.Z git tags for versioned iterations.
• Version-file updates that match the project stack, such as package.json for React projects.
• Neutral public metadata without AI tool, agent, or provider names.

Presets

• lean-context: context-loading, MCP, compression, usage tracking, template/preset recommendation, and GitHub workflow rules for maximizing useful AI quota.

Templates

• docs-only
• react-vite-spa
• laravel-react
• chrome-extension-vanilla

Documentation Map

• Agent rules
• Pragmatik CLI
• Installation
• AI Context
• AI Clients
• AI Search
• AI Measurement
• AI Token Budget
• AI Tool Setup
• AI Tool Registry
• AI Usage Report
• AI Optimization Report
• Catalog
• Conventions
• Naming
• Roadmap
• Workflows
• Snapshots
• Technical Debt

GitHub Project

• Pragmatik Project Board — tracks milestones, issues, and work items.

Use pragmatik doctor during repository analysis, then pragmatik setup when tooling or dashboard setup is missing. Use pragmatik run to execute configured AI tools, append aggregate usage summaries, and append optimization observations when enabled. Use pragmatik dashboard for the local Pragmatik dashboard.

The npm package includes the AI-tool backend, so pragmatik run works as soon as Pragmatik is installed. A project-local scripts/ai-tools.sh remains an optional override for templates, hooks, and advanced workflows. Use bash scripts/ai-tools.sh measure-pair when that local script is present to run a matched baseline-vs-lean-context measurement.

Template defaults keep external tools optional. The Pragmatik dashboard and local reports are available by default, while external submission stays in dry-run until the user chooses on. Multi-client measurement is available through AGENTS_TOKSCALE_CLIENTS, with ready defaults for Codex, Cursor, Antigravity, Claude, Gemini, and Warp.

License

This repository is licensed under the MIT License.