Command index
Every splent command in alphabetical order, 138 in all. Each name links to its reference page.
C · D · E · F · L · M · P · R · S · T · V · W · Make targets
This list is built from the reference pages, so it always matches them. To find the commands for one task, such as setting up a product or releasing a feature, browse the sections in the sidebar instead.
C
| Command | What it does |
|---|---|
cache:clear |
Delete feature cache entries (total or partial) and remove broken symlinks from products. |
cache:orphans |
List cache entries that no product references in its pyproject.toml. |
cache:outdated |
Show products that are using an older feature version than the latest one available in the local cache. |
cache:prune |
Remove orphaned cache entries not referenced by any product, then clean up broken symlinks. |
cache:size |
Show disk usage of the feature cache, broken down by namespace and entry. |
cache:status |
Show all feature entries (pinned snapshots in the cache and editable features at the workspace root). |
cache:usage |
Show which products declare each feature in their pyproject.toml. |
cache:versions |
List all cached entries (editable and versioned snapshots) for a specific feature. |
check:contracts |
Verify that feature contracts and SPL UVL constraints tell the same dependency story. |
check:deps |
Validate that the features’ code only depends on the features the UVL model says it may depend on. |
check:docker |
Verify Docker and Docker Compose are available and the daemon is running. |
check:env |
Validate workspace environment variables and tool versions. |
check:features |
Validate every declared feature (location, symlinks, pip install, and git state). |
check:forge |
Verify the forge credentials from the .env file. |
check:infra |
Validate Docker infrastructure declarations across all features and the product without starting any containers. |
check:product |
Validate the active product’s feature integration (environment variables, symlinks, configuration, and blueprint registration). |
check:pypi |
Verify PyPI credentials from the .env file. |
check:pyproject |
Validate the active product’s pyproject.toml (parsing, dependencies, feature declarations, duplicate detection, namespace consistency, and SPL/UVL configuration). |
check:releases |
Report forge and PyPI divergence for every releasable package in the workspace. |
clear:build |
Clear Python bytecode cache and build artifacts from the workspace. |
clear:log |
Delete the app.log file. |
clear:uploads |
Clear the contents of the uploads/ directory without removing the folder itself. |
command:create |
Create a new CLI command skeleton. |
coverage |
Run pytest with coverage reporting on a feature or the full product. |
D
| Command | What it does |
|---|---|
db:console |
Open an interactive MariaDB console using the credentials from .env. |
db:dump |
Create a SQL dump of the MariaDB database. |
db:migrate |
Generate Alembic migration scripts for all features or a single one. |
db:reset |
Drop all tables (or just one feature’s) and re-apply migrations from scratch. |
db:restore |
Restore a MariaDB database from a SQL dump file. |
db:rollback |
Roll back migrations for a specific feature, respecting UVL dependencies. |
db:seed |
Populate the database using feature-level seeders, in topological dependency order. |
db:status |
Show the current migration status for all tracked features. |
db:upgrade |
Apply pending migrations for all features or a single one, without generating new scripts. |
doctor |
Run all diagnostic checks on the workspace and report a summary. |
E
| Command | What it does |
|---|---|
env:list |
List variables defined in the active .env file, grouped by category. |
env:set |
Set a few workspace .env variables interactively. |
env:show |
Display the current .env variables and check which ones are loaded in the shell session. |
export:puml |
Generate PlantUML diagrams from the active product’s feature model, database models, dependencies, and Docker topology. |
F
| Command | What it does |
|---|---|
feature:add |
Add a local (non-versioned) editable feature from the workspace root to the active product. |
feature:attach |
Attach a released (versioned) feature to the active product. |
feature:clean |
Detect and remove scaffold stubs from a feature. |
feature:clone |
Clone a remote feature repository into the local SPLENT cache. |
feature:compat |
Compare two features and report compatibility issues. |
feature:compile |
Compile frontend assets (JS/CSS) for one or all features of the active product. |
feature:contract |
Infer the feature contract from source code at any time. No release required. |
feature:create |
Scaffold a new feature at the workspace root. |
feature:delete |
Delete a versioned feature snapshot from the SPLENT cache. |
feature:detach |
Detach a versioned (pinned) feature from the active product without deleting the cached copy. |
feature:discard |
Delete the editable copy of a feature, the working copy at the workspace root. |
feature:drift |
Show which SPLENT-owned feature scaffold files have drifted from the current templates. |
feature:env |
Manage .env files for a feature (based on the feature symlink inside the active product). |
feature:fork |
Fork a feature from the official namespace on the git forge and clone it locally. |
feature:git |
Run any git command inside a feature’s directory without knowing where it lives on disk. |
feature:hook:add |
Add a new template hook registration to a feature’s hooks.py. |
feature:hook:remove |
Remove a template hook registration from a feature’s hooks.py. |
feature:hooks |
List all template hook registrations declared in a feature’s hooks.py. |
feature:impact |
Show the full dependency impact of adding or removing a feature. |
feature:info |
Show a feature’s contract, dependencies and usage, without cloning it. |
feature:inject-config |
Generate or update a feature’s config.py from environment variables detected in source code. |
feature:install |
Install a feature into the active product in one interactive step (clone, register, configure, and start). |
feature:list |
List all features declared in the active product, grouped by environment. |
feature:order |
Show the topological load order of features in the active product, resolved against UVL dependency constraints. |
feature:outdated |
Check if any pinned features have newer versions tagged on the git forge. |
feature:pin |
Pin all editable features to their latest cached version. |
feature:pip-install |
Install the declared features from PyPI, or from their git tag when PyPI does not serve them. |
feature:pull |
Run git pull on the editable features, the working copies at the workspace root. |
feature:refine |
Interactive wizard to configure refinement for a feature. Extend models, override services, templates, and hooks from a base feature. |
feature:release |
Release a feature. Auto-infer its contract, bump version, tag, publish to the git forge and PyPI, and create a versioned cache snapshot. |
feature:remove |
Remove a local (non-versioned) feature from the active product. |
feature:rename |
Rename a local feature in the cache. If the feature is active in the current product, SPLENT also updates the product reference. |
feature:search |
Search features in the marketplace index, or live on the git forge. Alias of marketplace:search. |
feature:status |
Show the lifecycle state of every feature attached to the active product. |
feature:sync-template |
Apply template updates to SPLENT-owned feature scaffold files without touching developer code. |
feature:test |
Run the test suite for one or all features of the active product, with granular level selection. |
feature:translate |
Extract, initialize, or compile translations for one or all features of the active product. |
feature:unlock |
Convert one or all versioned (pinned) features to editable at the workspace root. |
feature:upgrade |
Upgrade declared features to the latest version tagged on the git forge. |
feature:versions |
List all available versions of a feature from its git tags on the forge and its PyPI releases. |
feature:xray |
Inspect a feature’s extension points, template hook registrations, and refinement map. Shows what a feature exposes, what it fills, and what has been overridden by refinement features. |
L
| Command | What it does |
|---|---|
lint |
Run Ruff to lint and optionally auto-fix and reformat the project. |
locust |
Start Locust load tests inside the product’s web container, and stop them with locust:stop. |
locust:stop |
Start Locust load tests inside the product’s web container, and stop them with locust:stop. |
login |
Authenticate against the SPLENT marketplace and store the token, the way docker login does. |
logout |
Remove the stored SPLENT marketplace token and revoke it on the server. |
M
| Command | What it does |
|---|---|
marketplace:index |
Build the marketplace index from feature contracts and the SPL models. |
marketplace:search |
Search features in the marketplace index, or live on the forge. |
P
| Command | What it does |
|---|---|
product:auto-require |
Automatically add missing required features to pyproject.toml based on UVL constraints. |
product:build |
Build deployment artifacts (.env.deploy.example and docker-compose.deploy.yml) by merging the product and its features. |
product:clean |
Nuclear reset. Stop all containers, wipe volumes, reset the database, and clear uploads and logs. |
product:commands |
List all CLI commands contributed by features in the active product. |
product:config |
Show the final resolved configuration of the active product, with origin tracing for every key. |
product:configure |
Interactive SPL feature configurator with constraint propagation and formal validation. |
product:console |
Interactive Python shell with the Flask app, database, and all feature models loaded. |
product:containers |
Show Docker container status for the active product and all its features. |
product:create |
Scaffold a new product inside the workspace. |
product:deploy |
Deploy the product using docker-compose.deploy.yml and .env.deploy. |
product:derive |
Full SPL product derivation pipeline. Validates the product configuration, then syncs, configures, builds and launches it in one command. |
product:deselect |
Deselect the active product and enter detached mode. |
product:down |
Stop the active product and its features using Docker Compose. |
product:drift |
Show which SPLENT-owned product files have drifted from the current templates. |
product:env |
Generate or merge .env files for the active product (and optionally its features). |
product:list |
List all products found in the workspace. |
product:logs |
Stream logs from the active product’s Docker Compose services. |
product:missing |
Show features required by the UVL model that are not present in pyproject.toml. |
product:port |
Show the real URL and port where the active product is running. |
product:release |
Release a product. Bump version, create the Git tag, publish the release on the forge (git.splent.io by default), publish to PyPI, and push a Docker image to Docker Hub. |
product:resolve |
Synchronize all versioned features declared in the active product. |
product:restart |
Restart the active product’s Flask app without recreating containers. |
product:routes |
Show all HTTP routes registered by the active product, with feature attribution. |
product:run |
Execute the product entrypoint inside the main container. |
product:select |
Select the active product in the workspace. |
product:shell |
Open an interactive shell inside the active product’s main container. |
product:signals |
Show all signals defined by features in the active product, with provider and listener attribution. |
product:sync-template |
Apply template updates to SPLENT-owned product files without touching developer code. |
product:test |
Run all feature tests for one or more products. Works in both attached and detached mode. |
product:up |
Start the active product and all its declared features using Docker Compose. |
product:validate |
Validate the product’s configuration, compatibility, and dependencies. |
R
| Command | What it does |
|---|---|
release:cli |
Release a new version of splent_cli to the git forge and PyPI. |
release:framework |
Release a new version of splent_framework to the git forge and PyPI. |
release:resume |
Finish a release that reached one channel and not the other, without bumping the version. |
S
| Command | What it does |
|---|---|
selenium |
End-to-end browser automation tests using Selenium. |
spl:add-constraints |
Interactive wizard to add missing UVL constraints based on code analysis. |
spl:add-feature |
Add a feature to an SPL with auto-detected dependency constraints. |
spl:compare |
Compare two products in the workspace by their feature sets (what they share and what is specific to each). |
spl:configurations |
Enumerate the valid feature selections of an SPL’s UVL model. |
spl:create |
Start a new SPL model in its own workspace directory. |
spl:deps |
Show dependencies implied by UVL constraints for a given feature. |
spl:features |
List all features defined in an SPL’s UVL model. |
spl:fetch |
Download an SPL model from UVLHub into the local cache. |
spl:info |
Show everything the workspace knows about one SPL model. |
spl:list |
List every SPL model the workspace can name. |
spl:outdated |
Report products pinned to an older SPL model than the one that exists. |
spl:pin |
Record which SPL model the active product derives from, by DOI, in its own pyproject.toml. |
spl:publish |
Publish the local UVL model of an SPL through the marketplace, and record the DOI it reports. |
spl:remove-feature |
Remove a feature from an SPL, together with the constraints that name it. |
T
| Command | What it does |
|---|---|
tokens:setup |
Show step-by-step instructions for obtaining and configuring the tokens required by SPLENT commands. |
V
| Command | What it does |
|---|---|
version |
Show a complete version snapshot of the SPLENT workspace. |
W
| Command | What it does |
|---|---|
whoami |
Show who this machine is on the SPLENT marketplace, and which credential won. |
Make targets
These are plain make targets. They run on the host, before you are inside the CLI container. See Manage for when to use each one.
| Target | What it does |
|---|---|
make cli |
Enter the running CLI container, the day-to-day shortcut. |
make docker-up |
Ensure the .env, then start the CLI container. |
make env-check |
Validate the workspace .env. Read-only, changes nothing. |
make env-prepare |
Ensure the workspace .env exists and is correct. |
make fix-app |
Clear a dangling SPLENT_APP and return to detached mode. |
make fix-env |
Repair everything repairable in .env, then validate. |
make fix-workdir |
Repair the workspace paths in .env when they are wrong or stale. |
make help |
List every available Make target with a one-line description. |
make preflight |
Run the host pre-flight checks only. No container, no changes. |
make setup |
Full first-time setup in a single command. |
make setup-rebuild |
Tear down and rebuild the environment from scratch. |