dev-run

Automates start, restart, and stop of FastAPI and Vite dev servers.

Updated Apr 11, 2026
One-click install
npx skills add https://github.com/lmveloso/finance-hledger --skill dev-run
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dev-run
Source: https://github.com/lmveloso/finance-hledger/tree/main/skills/dev-run
Command: npx skills add https://github.com/lmveloso/finance-hledger --skill dev-run

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, lsof, hledger, python3, node, npm, and includes scripts (resource) components.

What problem does it solve?

This Skill eliminates the tedious, error-prone manual work of setting up the finance-hledger local development environment, which requires coordinating a FastAPI backend, Vite frontend, Python virtual environment, Node dependencies, hledger CLI validation, and correct environment variable configuration that often causes silent uvicorn failures.

Core Features & Use Cases

  • Idempotent Startup: The included startup script handles first-run setup (venv creation, npm install, .env scaffolding) and safely restarts existing dev servers if they are already running.
  • Prerequisite Validation: Automatically checks for required tools including hledger 1.52+, Python 3.10+, and Node 18+, and provides clear install instructions if any are missing.
  • Safe Shutdown: The stop script only kills the dev processes it started, with fallback logic to avoid accidentally terminating unrelated services running on ports 8080 or 5173.
  • Use Case: A developer contributing to the finance-hledger project can use this Skill to spin up the full local dev stack in one command instead of running 10+ separate manual setup and startup steps, and cleanly shut it down when finished.

Quick Start

Use the dev-run skill to start the full local finance-hledger development environment with the backend on port 8080 and frontend on port 5173, or run the provided stop script to cleanly shut down all dev processes when you are finished working.

Frequently Asked Questions about dev-run

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I start the local FastAPI and Vite development environment for finance-hledger in one command?

To start the local FastAPI and Vite development environment, run the dev-run startup script which handles venv creation, npm install, .env scaffolding, and safely launches the backend and frontend dev servers idempotently.

What prerequisites do I need to run the finance-hledger local dev environment?

The finance-hledger local dev environment requires hledger 1.52+, Python 3.10+, and Node 18+ installed locally, along with curl and lsof for prerequisite validation and safe process management.

Why does uvicorn fail to start silently when running the FastAPI backend locally?

Uvicorn startup failures in the FastAPI backend are often caused by misconfigured environment variables; the dev-run script provides automatic resolution and .env scaffolding to prevent these silent crashes.

Can I safely shut down FastAPI and Vite dev servers without killing unrelated processes on ports 8080 and 5173?

Yes, the stop script safely shuts down only the project-specific FastAPI and Vite dev processes it started, using fallback logic to avoid accidentally terminating unrelated services on ports 8080 and 5173.

What is the best way to automate first-run dependency installation for a full-stack Python and Node.js project?

Automating first-run dependency installation for full-stack Python and Node.js projects is handled by the dev-run script, which idempotently creates the virtual environment, runs npm install, and scaffolds environment variables.

How do I restart existing dev servers if the FastAPI and Vite processes are already running?

To restart existing dev servers, run the dev-run startup script again; it detects running FastAPI and Vite processes and safely restarts them without duplicating instances or requiring manual termination.