Skip to main content

Makefile command reference

This page summarizes the repository-level Makefile commands that are most relevant for installation, development, testing, docs, and release work.

The commands below are grouped by usage scenario rather than by where they are defined, so you can find the right entrypoint faster during day-to-day work.

Installation and initialization

CommandPurpose
make initInstall backend and frontend dependencies and enable pre-commit
make init_dbCreate the target database when needed, then initialize schema and exported init data
make export_db_init_dataExport filtered initialization data from PostgreSQL

Application runtime

CommandPurpose
make backendRun the backend in development mode
make backend_startRun the backend without dependency sync
make frontendInstall dependencies and run the frontend in development mode
make frontendcClean-install frontend dependencies and then run the frontend development server
make run_frontendStart the frontend development server directly
make run_cliStart SkillFlaw quickly with a built static frontend
make run_clicStart SkillFlaw after cleaning and rebuilding frontend assets
make run_cli_debugStart the CLI in a debug-oriented mode
make setup_envPrepare environment variables

Use make frontend when you want the Vite development server workflow, and use make run_cli / make run_clic when you want a production-style local runtime with built frontend assets served by the backend.

Frontend development and asset build

CommandPurpose
make install_frontendInstall frontend dependencies with npm install
make install_frontendciInstall frontend dependencies with npm ci
make install_frontendcReinstall frontend dependencies after cleaning node_modules and lock artifacts
make build_frontendBuild frontend static assets and copy them to the backend frontend directory
make storybookStart the Storybook development server
make storybook_buildBuild static Storybook assets
make storybook_networkStart Storybook so it is reachable on the local network

Code quality and checks

CommandPurpose
make formatRun backend and frontend formatting
make format_backendFormat backend code with Ruff
make format_frontend_checkRun Biome checks on frontend files
make lintRun backend type and lint checks
make codespellRun spelling checks
make fix_codespellAuto-fix spelling issues where possible

Testing and validation

CommandPurpose
make testsRun the combined test workflow
make unit_testsRun backend unit tests
make integration_testsRun backend integration tests
make integration_tests_no_api_keysRun integration tests that do not need API keys
make integration_tests_api_keysRun integration tests that require API keys
make tests_frontendRun frontend e2e tests
make test_frontendRun frontend Jest unit tests
make template_testsRun starter project template tests

Documentation workflows

CommandPurpose
make docs_installInstall docs dependencies with repository-local Yarn cache
make docsStart the docs development server on port 3030
make docs_buildBuild production docs output
make docs_serveBuild and serve docs locally

Build, version, and release

CommandPurpose
make buildBuild project artifacts
make patch v=1.0.0b1Update the root VERSION file and synchronize consumers
make sync_versionSynchronize versioned files from the root VERSION
make check_version_syncVerify versioned files match the root VERSION
make publishPublish packages when the release pipeline is ready

Help commands

The Makefile already groups many commands through help targets:


_10
make help
_10
make help_backend
_10
make help_frontend
_10
make help_test
_10
make help_advanced

Use these first when you are not sure which entry point belongs to a workflow.

Fresh local setup


_10
make init
_10
make init_db
_10
make backend
_10
make frontend

This workflow uses the frontend development server. If you want a production-style local runtime instead, use make run_cli or make run_clic.

Production-style local validation


_10
make init
_10
make init_db
_10
make run_cli

Docs contribution loop


_10
make docs
_10
make docs_build

Safe code validation before commit


_10
make format
_10
make lint
_10
make unit_tests