runtimekit-cli 0.3.1

Generic CLI for scaffolding and managing modular runtime applications.

RuntimeKit CLI

RuntimeKit CLI is a generic command-line tool for scaffolding and managing modular runtime applications.

It can generate modules, pages, stores, backend routes, descriptor wiring, dependency wiring, release commands, installer collection, and safe cleanup commands for a workspace that follows a modular runtime layout.

Install

From PyPI after publishing:

python -m pip install runtimekit-cli

From GitHub before publishing:

python -m pip install "runtimekit-cli @ git+https://github.com/Susheer/runtimekit-cli.git"

Configure

Run this once per machine or environment:

runtimekit config init --workspace /path/to/spec --name "My Runtime"

The configured name is only local CLI metadata. It does not need to be hardcoded into the package.

Show config:

runtimekit config show

Common Commands

runtimekit doctor
runtimekit add module APP.WorkOrders --menu-parent Operations
runtimekit add page APP.WorkOrders WorkOrderDetails
runtimekit add store APP.WorkOrders WorkOrdersStore
runtimekit add dependency APP.WorkOrders OTHER.SharedFeature
runtimekit add include OTHER.SharedFeature --app APP
runtimekit add theme --app APP
runtimekit prepare
runtimekit inspect runtime
runtimekit run browser --open
runtimekit run electron
runtimekit release make --target mac-dmg
runtimekit clean --target build --target installer --dry-run
runtimekit remove module APP.WorkOrders --dry-run
runtimekit remove theme --app APP --yes

Destructive commands require --yes unless --dry-run is used.

Design-Aware Scaffolding

runtimekit add module now creates a full starter module instead of a blank shell:

• Three visible pages in the same navigation group.
• A module-scoped frontend store with fake data for every generated page.
• backend/module.js, route, and service files returning sample data.
• Strict module.json with page-level pageType, icon, menu, restore-state, keep-alive, frontend.entry, and backend.routePrefix.
• MUI/platform UI page templates using cards, metrics, status pills, and data tables.

runtimekit add page adds the new page under the module's existing navigation group by default, refreshes sample data, and keeps the generated frontend module export aligned with module.json.

The CLI does not write deprecated manifest fields such as permissions, metadata, backend.routes, backend.services, backend.initOrder, frontend.stores, or frontend.slots. Runtime behavior belongs in frontend/module.js and backend/module.js.

runtimekit add theme adds root-app theme resources for an external app. By default it targets the root.app configured in local.properties; use --app APP to be explicit. It writes styles/themeset.js, a companion CSS file, assets/, static/, and wires themeSet, styles, assets, and static into the app module-descriptor.json. The generated token set intentionally uses a visibly different palette from the default runtime theme so stakeholders can see the composition effect immediately.

runtimekit remove theme removes only external app theme wiring. The default runtime/core theme cannot be edited or deleted by this CLI.

Release Artifacts

Release builds can collect generated installer files into a root-level installer folder:

runtimekit release make --target mac-dmg

The collected output defaults to:

installer/

Override it with:

runtimekit release make --target mac-dmg --installer-dir published-installers

Development

python -m unittest discover -s tests
PYTHONPYCACHEPREFIX=/tmp/runtimekit_pycache python -m py_compile runtimekit_cli/cli.py tests/test_cli.py
python -m build

Publish

The recommended publish flow is PyPI Trusted Publishing from GitHub Actions. Create a PyPI project for runtimekit-cli, configure a trusted publisher for this repository, then publish by creating a GitHub release.