Skip to main content

Generic CLI for scaffolding and managing modular runtime applications.

Project description

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 --backend --store
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 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

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runtimekit_cli-0.1.0.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runtimekit_cli-0.1.0-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file runtimekit_cli-0.1.0.tar.gz.

File metadata

  • Download URL: runtimekit_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for runtimekit_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f5bbfc38c51d4bbf9beb03befa09b9f59a00868278714f6595346a04737d9c6c
MD5 a0319a736b0107e17fe63fb15d79f3db
BLAKE2b-256 0ba986b3469919e71bf6d28b8d441591641f5258e0ec9d14ba711690574fdde7

See more details on using hashes here.

Provenance

The following attestation bundles were made for runtimekit_cli-0.1.0.tar.gz:

Publisher: publish.yml on Susheer/runtimekit-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file runtimekit_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: runtimekit_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for runtimekit_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a36ebc2a1ea89c4e6abe259c92295d17cf4c96c277787976046d8beb67d6263
MD5 ee81b1affa26fe77ac823ae1cd971434
BLAKE2b-256 e2ed5c88d9f9f1a1ff458f55137f2e414db3e6fe8e298d16fc189eb40fd8d791

See more details on using hashes here.

Provenance

The following attestation bundles were made for runtimekit_cli-0.1.0-py3-none-any.whl:

Publisher: publish.yml on Susheer/runtimekit-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page