Merge pull request #1206 from Kiln-AI/leonard/kil-508-chore-add-some-commands-in-makefile

chore: add makefile with commands for common scripts

Author: leonardmq

CONTRIBUTING.md

@@ -41,6 +41,10 @@ To run the API server, Studio server, and Studio Web UI with auto-reload for dev
 
 3. Open the app: http://localhost:5173/run
 
+### Makefile
+
+The root `Makefile` provides convenient shortcuts for commonly used scripts (`make dev`, `make ui`, `make package`, ...).
+
 ### Running and Building the Desktop App
 
 See the [desktop README](app/desktop/README.md) instructions for running the desktop app locally.

Makefile

@@ -0,0 +1,39 @@
+.PHONY: dev ui schema annotations check package
+
+# Run the development API server (desktop dev server with hot reload on port 8757).
+dev:
+	uv run python -m app.desktop.dev_server
+
+# Run the Vite dev server for the web UI (http://localhost:5173 by default).
+ui:
+	cd app/web_ui && npm run dev --
+
+# Regenerate api_schema.d.ts from the running server's OpenAPI spec (server must be up on :8757).
+schema:
+	cd app/web_ui/src/lib && ./generate_schema.sh
+
+# Dump agent-check annotation JSON files from the running server's OpenAPI (server must be up on :8757).
+annotations:
+	uv run python -m kiln_server.utils.agent_checks.dump_annotations http://localhost:8757/openapi.json libs/server/kiln_server/utils/agent_checks/annotations
+
+# Run formatting, linting, typechecking, tests, and builds via the repo checks script.
+check:
+	uv run ./checks.sh
+
+# Package a project to a zip via kiln_ai package_project. Example: make package ARGS='~/KilnProjects/demo/project.kiln --all-tasks -o ./kiln_export.zip'
+package:
+	@if [ -z "$(strip $(ARGS))" ]; then \
+		if [ -t 1 ]; then \
+			e=$$(printf '\033'); \
+			U="$${e}[1;33m"; H="$${e}[1;36m"; D="$${e}[90m"; N="$${e}[33m"; L="$${e}[34m"; R="$${e}[0m"; \
+		else \
+			U=; H=; D=; N=; L=; R=; \
+		fi; \
+		printf '%s\n' "$${U}Usage:$${R} make package ARGS='<path/to/project.kiln> [options]'"; \
+		printf '%s\n' "$${H}Example:$${R}"; \
+		printf '%s\n' "    $${D}make package ARGS='~/Kiln\\ Projects/demo/project.kiln --all-tasks -o /tmp/kiln_export.zip'$${R}"; \
+		printf '%s\n' "    $${D}make package ARGS='~/Kiln\\ Projects/demo/project.kiln --task 314310835537 -o \"/tmp/kiln_export.zip\"'$${R}"; \
+		printf '%s\n' "$${N}Note:$${R} Remember to escape spaces and apostrophes or quotes in the path."; \
+		printf '%s\n' "$${L}See also:$${R} uv run kiln_ai package_project --help"; \
+	fi
+	uv run kiln_ai package_project $(ARGS)