gofasta doctor

Verifies that required and optional tools are installed, checks project configuration, and tests database connectivity. Useful for diagnosing setup issues and for including in bug reports.

Usage


gofasta doctor

This command takes no flags.

Examples


$ gofasta doctor
Required:
  ✓ go           go version go1.25.0 darwin/arm64
  ✓ migrate      v4.18.1
 
Optional:
  ✓ docker       Docker version 27.4.0
  ✓ air          available (Go tool)
  ✓ wire         available (Go tool)
  ✓ gqlgen       available (Go tool)
  ✓ swag         available (Go tool)
 
Project:
  ✓ config.yaml  found
  ✓ database     reachable

What It Checks

Required Tools

Tool	What it checks
`go`	Go compiler is installed and reports its version
`migrate`	golang-migrate CLI is installed

Optional Tools

Tool	What it checks
`docker`	Docker is installed (needed for `docker compose` workflows)
`air`	Air hot-reload tool is available as a Go tool
`wire`	Google Wire DI generator is available
`gqlgen`	GraphQL code generator is available (only needed for GraphQL projects)
`swag`	Swagger/OpenAPI generator is available

Project Health

When run inside a project directory (where config.yaml exists):

Check	What it verifies
`config.yaml`	Configuration file exists
`database`	Database is reachable using the connection details from config
`refactor`	Layout-migration eligibility — runs the same full-project preflight as `gofasta refactor status`: a summary line, one `✗` entry per blocker (torn layout state, unparseable files, non-scaffold `gqlgen.yml`, no git repository), one info entry per warning (unmanaged files, renamed scaffold symbols, missing generator markers). These entries never fail the doctor run — they describe the project’s shape, not broken prerequisites

gofasta init
Initialize a cloned or existing Gofasta project by installing dependencies and running code generators.
gofasta dev
Bring the full local environment up with one command — compose services + migrations + Air hot reload, with interactive restart.
gofasta debug
CLI surface for the devtools /debug/* endpoints — requests, SQL, traces, logs, errors, cache, pprof, EXPLAIN, HAR, plus the composed...
gofasta ai
Install per-agent configuration for Claude Code, Cursor, OpenAI Codex, Aider, and Windsurf — permission allowlists, hooks, project rules, and slash commands.
gofasta verify
Run the full preflight gauntlet — gofmt, vet, golangci-lint, tests, build, Wire drift, routes — in one command.
gofasta test
Run go test against the project with gofasta defaults — race detector on, every package, live output, plus shortcuts for short/integration/coverage/run-pattern.
gofasta status
Report the health of the current project — Wire drift, swagger drift, pending migrations, uncommitted generated files, module freshness.
gofasta inspect
Show the full composition of a resource — model fields, DTOs, service methods, controller methods, routes — as structured output.
gofasta inspect-jobs
Static AST scan of app/jobs/ that lists every registered cron job with its schedule from config.yaml.
gofasta inspect-tasks
Static AST scan of app/tasks/ that lists every async task with its wire name, payload shape, and handler/enqueuer presence.
gofasta impact
Reverse-dependency analysis — given a file or import path, list every package that depends on it (directly + transitively) and every Go source file in those packages.
gofasta xrefs
Type-aware reverse symbol lookup — find every reference to a Go func, type, method, var, or const across the current module.
gofasta do
Run a named development workflow — a pre-defined chain of gofasta commands that together accomplish one higher-level task.
gofasta config
Inspect and validate your project's config.yaml — currently the schema emitter, more subcommands to come.
gofasta serve
Run the project's HTTP server in production mode — no Air, no hot reload.
gofasta refactor
Switch a Gofasta project between layered and feature-package layouts without rewriting code by hand.
gofasta migrate
Run database migrations up or down for your Gofasta project, with static analysis (--explain), safe rollbacks (--steps, --all), and dirty-state repair (migrate repair).
gofasta seed
Run database seeders to populate your database with initial or test data.
gofasta db
Destructive database utilities, kept separate from `gofasta migrate` on purpose.
gofasta deploy
Deploy a Gofasta application to a remote VPS via SSH using Docker or a compiled binary, with a health gate and automatic rollback.
gofasta wire
Regenerate Google Wire dependency injection code for your Gofasta project.
gofasta swagger
Generate OpenAPI/Swagger documentation from the `@Summary`, `@Tags`, `@Router`, and `@Param` annotations the scaffold and `g endpoint` emit.
gofasta routes
Print every registered REST route in the project as a formatted table — method, path, and source file.
gofasta console
Start an interactive Go REPL in your project directory, powered by yaegi, for one-off data inspection and exploring an API surface without writing a throwaway main().
gofasta upgrade
Self-update the Gofasta CLI to the latest GitHub release.
gofasta version
Print the CLI version, the Go toolchain it was compiled with, and the OS/architecture target.
Error codes
Reference for every structured error code the Gofasta CLI emits — the stable machine-readable identifiers in `--json` output, grouped by...
Installation