doctor

Run all diagnostic checks on the workspace and report a summary.


Table of contents

  1. Usage
  2. Options
  3. Exit codes
  4. Sections
    1. Environment
    2. Product
    3. Services
    4. Credentials (skipped with –fast)
  5. Example output
  6. doctor vs product:validate
  7. See also

Usage

splent doctor
splent doctor --fast    # skip network and database checks

Options

Option Description
--fast Skip slow checks: check:github, check:pypi, db:status

Exit codes

  • 0: all checks passed
  • 1: one or more checks failed

Sections

Doctor runs 11 checks organized in 4 sections. Each is a standalone command.

Environment

Command What it checks
check:env Python, env vars, CLI/framework versions
check:pyproject pyproject.toml parsing, deps, UVL
check:docker Docker binary, Compose, daemon
check:infra Docker infrastructure: ports, services, networks

Product

Command What it checks
check:product Env vars, symlinks, config files
check:features Feature cache, symlinks, pip install state
feature:status Lifecycle state of each feature

Services

Command What it checks
product:containers Docker containers for the product and features
db:status Migration status per feature

Credentials (skipped with –fast)

Command What it checks
check:github GitHub credentials and API access
check:pypi PyPI credentials and token format

Example output

  SPLENT Doctor

  ── Environment ──

  check:env
  [✔] Python 3.13.12
  [✔] SPLENT_APP = my_first_app
  [✔] CLI 1.4.5 / Framework 1.4.5 — compatible

  check:pyproject
  [✔] Valid pyproject.toml

  check:docker
  [✔] Docker 24.0.7
  [✔] Compose v2.23.0

  check:infra
  [✔] No port conflicts

  ── Product ──

  check:product
  [✔] env vars OK

  check:features
  [✔] 7 features, all symlinks valid

  feature:status
  splent_io/splent_feature_auth  editable  ●─●─●─●  active

  ── Services ──

  product:containers
  my_first_app_web     running    5269→5000

  db:status
  splent_feature_auth → 990210b54b52

  ── Credentials ──

  check:github
  [✔] Authenticated as splent-io

  check:pypi
  [✔] Token valid

  ── Summary ──
  Passed: 11
  All checks passed.

doctor vs product:validate

Command Purpose
splent doctor Is my environment healthy? (Python, Docker, credentials, symlinks)
splent product:validate Is my product valid? (UVL satisfiability, contract compatibility, import constraints)

Run doctor when something is broken. Run product:validate before deploying.


See also


Back to top

splent. Distributed by an LGPL license v3. Contact us: drorganvidez@us.es