Runtime commands#
The runtime is installed separately from the Python package. Install it before
authentication or a live design build. Starting a runtime is a separate action:
install and update do not start a project server.
jitx runtime install --version 4.4.0
jitx runtime start --background
jitx runtime status
jitx runtime stop
jitx runtime#
Choose a runtime operation; the group itself shows help.
jitx runtime introspect#
Report the installed runtime’s environment and configuration, including its version and paths. This needs an installed launcher; it does not start a design server.
jitx runtime introspect
Argument / option |
Default |
Meaning |
|---|---|---|
|
|
Re-run introspect even if a cached snapshot exists in this process. |
jitx runtime install#
Download and install a runtime. Without --version, ask the backend for the
runtime matching the Python package running this command. With no backend flag,
use the installed runtime’s backend, falling back to production. Supply at most
one of --prod, --testing, or --url.
Automatic host selection recognizes Ubuntu, macOS, and Windows. Other Linux
distributions and WSL require an explicit target: ubuntu, macos, or windows.
The Ubuntu build may work on other glibc distributions; explicit selection does
not mean those hosts are tested. Host detection is not a guarantee that every OS
version is supported.
jitx runtime install --version 4.4.0 --progress
jitx runtime install --version 4.4.0 --target ubuntu
Argument / option |
Default |
Meaning |
|---|---|---|
|
unset |
Runtime version to install. Omit to let the backend pick the runtime matching this py-jitx version. |
|
|
Pull artifacts from production (app.jitx.com). |
|
|
Pull artifacts from the testing deployment (app-testing.jitx.com). |
|
unset |
Pull artifacts from an arbitrary backend. Useful for local dev (e.g. http://localhost:8000). |
|
unset |
Override host detection. One of: ubuntu, macos, windows. Values: |
|
|
Report download progress on stderr: a progress bar in text mode, NDJSON download_progress events with –format json. |
jitx runtime update#
Ensure the requested runtime is installed, or resolve a matching runtime from
the active Python package when --version is omitted. Do nothing if it already
matches; a development runtime is left untouched. Backend and target selection
work as for runtime install. This updates the runtime, not Python packages.
jitx runtime update --version 4.4.0
Argument / option |
Default |
Meaning |
|---|---|---|
|
unset |
Runtime version to ensure is installed. Omit to let the backend pick the runtime matching this py-jitx version. |
|
|
Pull artifacts from production (app.jitx.com). |
|
|
Pull artifacts from the testing deployment (app-testing.jitx.com). |
|
unset |
Pull artifacts from an arbitrary backend. Useful for local dev (e.g. http://localhost:8000). |
|
unset |
Override host detection. One of: ubuntu, macos, windows. Values: |
|
|
Report download progress on stderr: a progress bar in text mode, NDJSON download_progress events with –format json. |
jitx runtime start#
Start a project server. Foreground mode runs until interrupted and shows output
in the terminal. --background / --bg waits for readiness and returns. Logs go
to the project’s .jitx/logs/runtime.log. Other project commands reuse its connection.
The runtime must already be installed and licensed for the design work.
jitx runtime start --background
Argument / option |
Default |
Meaning |
|---|---|---|
|
unset |
JITX project root (directory containing pyproject.toml with |
|
unset |
Override the Unix-domain socket path. Defaults to the launcher’s default socket with a per-instance suffix appended. |
|
|
Detach the launcher and return once it’s announced itself. Logs go to .jitx/logs/runtime.log. |
jitx runtime stop#
Stop the runtime belonging to the selected project. Wait up to --timeout
seconds for graceful shutdown, then force termination. If none is running,
the command succeeds without stopping another project’s runtime.
jitx runtime stop --timeout 10
Argument / option |
Default |
Meaning |
|---|---|---|
|
unset |
JITX project root (directory containing pyproject.toml with |
|
|
Seconds to wait for graceful exit before escalating to SIGKILL. |
jitx runtime status#
Report project runtime reachability, including address, process ID, and uptime when available. This does not start a runtime.
jitx --format json runtime status
Argument / option |
Default |
Meaning |
|---|---|---|
|
unset |
JITX project root (directory containing pyproject.toml with |
jitx runtime cleanup#
Inspect launcher processes and stale sockets across the machine. The default
is report-only. --kill terminates the launcher processes found across projects;
use runtime stop for normal shutdown of just one project.
jitx runtime cleanup
Argument / option |
Default |
Meaning |
|---|---|---|
|
|
Terminate every launcher process we find (default: report only). |