Command reference

With what

Command reference

This page documents 28 commands, read off simplon’s command-line application as it is actually assembled - so it lists what can be typed, not what was intended.

Some commands are environment-agnostic and take no environment token; others are environment-first and take one between the product and the group (simplon <env> <group> <command>). Each command below says which it is, and its usage line shows the token where it belongs.

Command	Environment	Summary
`simplon build wheel`	agnostic	Build the wheel.
`simplon build reference`	agnostic	Write the product’s command reference as Markdown, read off its BUILT command line.
`simplon build acceptance`	agnostic	Write the product’s acceptance document as Markdown, read off its own .feature files.
`simplon build site`	agnostic	Build the product’s documentation website with Hugo, in Docker (HTML only).
`simplon build image`	agnostic	Build the product’s container image from its declared Dockerfile, with VERSION/REVISION.
`simplon build docs`	agnostic	Write the command reference, then build the website from it.
`simplon test suite`	agnostic	Run the pytest suite.
`simplon test typecheck-python`	agnostic	Type-check the product’s Python sources with mypy, in the host venv (no Docker, no lab).
`simplon test release-notes`	agnostic	Check the product’s releases page against the tags and merges its repository carries.
`simplon test report`	agnostic	Merge the unit results into the shared Allure results and render the HTML archive.
`simplon test generated`	agnostic	Fail if a committed generated file is not what its own command produces.
`simplon test walk`	agnostic	Walk the product’s acceptance scenarios with a person answering each step.
`simplon test all`	agnostic	Run every test: the pytest suite, the type gate, the staleness gate, then the release-notes guard.
`simplon release tag`	agnostic	Cut the release tag at HEAD and push it (`git push origin <tag>`, never `--tags`).
`simplon release image`	agnostic	Push the product’s container image and verify the tag is in the registry.
`simplon support install`	agnostic	Provision the host tooling the kernel needs - today oras; idempotent.
`simplon support completion`	agnostic	Regenerate the product’s shell completion from its manifest (–check reports drift and writes nothing).
`simplon support doctor`	agnostic	Check the tools and the environment.
`simplon support workflows`	agnostic	Regenerate the product’s GitHub workflows from its manifest (–check reports drift and writes nothing).
`simplon support claude-plugins`	agnostic	Install the Claude Code plugins declared in the manifest’s `claude` section; idempotent.
`simplon support ci-privileges`	agnostic	Give a user passwordless sudo and the docker group on THIS host (needs root; idempotent).
`simplon support git commit`	agnostic	git add -A + git commit -m.
`simplon support git push`	agnostic	git pull –rebase then push (current branch).
`simplon support git prune-branches`	agnostic	Delete local branches already merged into main (squash-aware via gh).
`simplon support git submodules`	agnostic	git submodule update –init lib/platform (init the submodule a fresh worktree needs).
`simplon support git auth-scopes`	agnostic	Grant the stored gh token the package scopes GHCR needs (interactive, idempotent).
`simplon support tasks catalogue`	agnostic	List the task coordinates the delivery kernel offers, marking the namespaces this product’s commands reach.
`simplon support tasks generate`	agnostic	Regenerate the product’s CLI module from its manifest (–check reports drift and writes nothing).

build

Produce the artefacts.

Environment-agnostic: these commands take no environment token - simplon build <command>.

`simplon build wheel`

simplon build wheel

Also spelled simplon wheel.

Build the wheel.

`simplon build reference`

simplon build reference

Also spelled simplon reference.

Write the product’s command reference as Markdown, read off its BUILT command line.

`simplon build acceptance`

simplon build acceptance [--source SOURCE]

Also spelled simplon acceptance.

Write the product’s acceptance document as Markdown, read off its own .feature files.

Parameter	Type	Default	Description
`--source`	text	`""`	the directory holding the .feature files (default: tests/acceptance)

`simplon build site`

simplon build site

Also spelled simplon site.

Build the product’s documentation website with Hugo, in Docker (HTML only).

`simplon build image`

simplon build image [--tag TAG]

Build the product’s container image from its declared Dockerfile, with VERSION/REVISION.

Parameter	Type	Default	Description
`--tag`	text	`""`	the tag to build under, for a version only known after a build

`simplon build docs`

simplon build docs

Also spelled simplon docs.

Write the command reference, then build the website from it.

test

Verify them.

Environment-agnostic: these commands take no environment token - simplon test <command>.

`simplon test suite`

simplon test suite

Also spelled simplon suite.

Run the pytest suite.

`simplon test typecheck-python`

simplon test typecheck-python [--config CONFIG] [--workdir WORKDIR] [--python PYTHON]

Also spelled simplon typecheck-python.

Type-check the product’s Python sources with mypy, in the host venv (no Docker, no lab).

Parameter	Type	Default	Description
`--config`	text	`mypy.ini`	path to the mypy configuration, relative to `workdir` (default mypy.ini)
`--workdir`	text	`""`	directory mypy runs in, relative to the product root (default: the root)
`--python`	text	`""`	interpreter to run mypy with, relative to `workdir` (default: the host venv the CLI runs in)

`simplon test release-notes`

simplon test release-notes

Also spelled simplon release-notes.

Check the product’s releases page against the tags and merges its repository carries.

`simplon test report`

simplon test report

Also spelled simplon report.

Merge the unit results into the shared Allure results and render the HTML archive.

`simplon test generated`

simplon test generated

Also spelled simplon generated.

Fail if a committed generated file is not what its own command produces.

`simplon test walk`

simplon test walk [--source SOURCE] [--tags TAGS] [--by BY] [--restart]

Also spelled simplon walk.

Walk the product’s acceptance scenarios with a person answering each step.

Parameter	Type	Default	Description
`--source`	text	`tests/acceptance`	directory holding the .feature files, relative to the product root (default tests/acceptance)
`--tags`	text	`""`	walk only the scenarios carrying one of these tags (comma- or space-separated; default all)
`--by`	text	`""`	who is walking it, for the record (default: the checkout’s own git identity)
`--restart`	flag	`False`	discard an interrupted walk’s recorded answers and ask every step again

`simplon test all`

simplon test all

Also spelled simplon all.

Run every test: the pytest suite, the type gate, the staleness gate, then the release-notes guard.

release

Publish them.

Environment-agnostic: these commands take no environment token - simplon release <command>.

`simplon release tag`

simplon release tag TAG

Also spelled simplon tag.

Cut the release tag at HEAD and push it (git push origin <tag>, never --tags).

Parameter	Type	Default	Description
`TAG`	text	required	the tag to cut, exactly as it will exist (e.g. v1.4.0)

`simplon release image`

simplon release image [--tag TAG]

Push the product’s container image and verify the tag is in the registry.

Parameter	Type	Default	Description
`--tag`	text	`""`	the tag to publish under, for a version only known after a build

support

Host preflight, environment introspection and host tooling.

Environment-agnostic: these commands take no environment token - simplon support <command>.

`simplon support install`

simplon support install

Also spelled simplon install.

Provision the host tooling the kernel needs - today oras; idempotent.

`simplon support completion`

simplon support completion [--check]

Also spelled simplon completion.

Regenerate the product’s shell completion from its manifest (–check reports drift and writes nothing).

Parameter	Type	Default	Description
`--check`	flag	`False`	report drift and write nothing

`simplon support doctor`

simplon support doctor

Also spelled simplon doctor.

Check the tools and the environment.

`simplon support workflows`

simplon support workflows [--check]

Also spelled simplon workflows.

Regenerate the product’s GitHub workflows from its manifest (–check reports drift and writes nothing).

Parameter	Type	Default	Description
`--check`	flag	`False`	report drift and write nothing

`simplon support claude-plugins`

simplon support claude-plugins [--dry-run]

Also spelled simplon claude-plugins.

Install the Claude Code plugins declared in the manifest’s claude section; idempotent.

Parameter	Type	Default	Description
`--dry-run`, `-n`	flag	`False`	List what is missing and install nothing.

`simplon support ci-privileges`

simplon support ci-privileges USER

Also spelled simplon ci-privileges.

Give a user passwordless sudo and the docker group on THIS host (needs root; idempotent).

Parameter	Type	Default	Description
`USER`	text	required

support git

Version-control helpers.

Environment-agnostic: these commands take no environment token - simplon support git <command>.

`simplon support git commit`

simplon support git commit [MESSAGE...]

Also spelled simplon commit.

git add -A + git commit -m.

Parameter	Type	Default	Description
`MESSAGE...`	text	none	commit message

`simplon support git push`

simplon support git push

Also spelled simplon push.

git pull –rebase then push (current branch).

`simplon support git prune-branches`

simplon support git prune-branches [--dry-run] [--remote] [--unmerged]

Also spelled simplon prune-branches.

Delete local branches already merged into main (squash-aware via gh).

Parameter	Type	Default	Description
`--dry-run`, `-n`	flag	`False`	preview only
`--remote`	flag	`False`	also delete merged branches on origin
`--unmerged`	flag	`False`	ALSO delete branches that cannot be proven merged (destructive)

`simplon support git submodules`

simplon support git submodules

Also spelled simplon submodules.

git submodule update –init lib/platform (init the submodule a fresh worktree needs).

`simplon support git auth-scopes`

simplon support git auth-scopes

Also spelled simplon auth-scopes.

Grant the stored gh token the package scopes GHCR needs (interactive, idempotent).

support tasks

The task machinery itself: regenerate the CLI module, list the tasks.

Environment-agnostic: these commands take no environment token - simplon support tasks <command>.

`simplon support tasks catalogue`

simplon support tasks catalogue

Also spelled simplon catalogue.

List the task coordinates the delivery kernel offers, marking the namespaces this product’s commands reach.

`simplon support tasks generate`

simplon support tasks generate TARGET [--check]

Also spelled simplon generate.

Regenerate the product’s CLI module from its manifest (–check reports drift and writes nothing).

Parameter	Type	Default	Description
`TARGET`	text	required
`--check`	flag	`False`	report drift and write nothing

Platform tasks this product has not placed

These are coordinates the delivery kernel’s catalogue offers that no command of this product instantiates, so they are in no group above and cannot be typed here. The list is what the PLATFORM offers, which is a wider set than what this product places.

Adopting one is not always just a command declaration. Some of them read product data of their own - a manifest section, a configuration file, a running environment - and placed without it they would fail on their first line; others need nothing but the declaration. The kernel’s catalogue says, at each coordinate, which of the two it is.

Task	What it does
`build:cmake-files`	Write this product’s CMakeLists.txt files from its source tree.
`build:conan-cache`	Fetch a published Conan cache archive so a build can restore it.
`build:dotnet-solution`	Write this product’s .sln and .csproj files from its source tree.
`build:nuget-config`	Write the product’s nuget.config naming the GitHub feed (no credential in it).
`build:nuget-restore`	Restore the declared project inside the SDK image, with the credential the feed needs.
`deploy:carrier`	Make the carrier this environment stands on: the machine, then the Portainer on it.
`deploy:down`	Remove a deployment - a client’s installed version, or a server’s environment.
`deploy:up`	Deploy a version - a published one, `latest`, or `local` for the current code base.
`docs:render`	Render the project docs via docToolchain (generateHTML + generatePDF) in Docker.
`release:artifact`	Publish a declared directory to a registry as an OCI artifact.
`release:asset`	Attach declared files to a GitHub release, creating it if it is not there yet.
`release:conan`	Publish a Conan cache archive to a registry as an OCI artifact (a transport, not a remote).
`release:nuget`	Pack the declared project and push it to GitHub’s NuGet feed.
`support:environments`	List the named environments and the backend each targets, marking the active one.
`support:nexus`	Drive the LAN Sonatype Nexus artefact proxy: up \| down \| status \| repos \| cleanup.
`support:toolchain`	Write a ready-made toolchain configuration for a language into this product’s manifest.
`test:accept`	Run the lab-based suites in sequence against the running lab.
`test:gate`	Run a declared pytest suite against the running lab.
`test:image`	Run the product’s container image and check that it answers.
`toolchain:run`	Run a pinned toolchain image over the product tree, as the calling user.

Acceptance scenarios