Support commands

Support bundles can contain project files, configuration, and logs. support bundle writes locally by default. support request sends the ticket text after confirmation; its --submit option additionally uploads diagnostic data. An installed runtime is needed to collect runtime diagnostics; submitting requests requires backend access. Both commands require a signed-in JITX account. See Getting Support for the bundle contents, exclusions, and an interactive walkthrough.

jitx support

Choose bundle or request; the group itself shows help.

jitx support bundle

Collect diagnostics into a local ZIP file, by default under ~/.jitx/support/. Without a detected project, runtime diagnostics can still be collected. An explicit invalid --project is an error. --description and --description-stdin are mutually exclusive. Inspect the bundle before sharing it. An existing file at the output path can be overwritten, including when using --out.

--submit uploads the bundle after confirmation and retains the local copy. --yes skips that confirmation; JSON mode requires --yes with --submit.

jitx support bundle --out diagnostics.zip --description "Build failure"

Argument / option	Default	Meaning
--description, -d	unset	Free-text notes attached to the bundle for support staff.
--description-stdin	false	Read the description from stdin. Useful for multi-line notes piped in from another tool (e.g. the VS Code extension).
--out	unset	Write the zip to this path instead of the default location under $HOME/.jitx/support/.
--submit	false	After building, upload the bundle to JITX (asks for confirmation first unless –yes is given).
--yes, -y	false	Skip the confirmation prompt before uploading. Required with –submit in JSON mode.
--project	unset	JITX project root (directory containing pyproject.toml with jitx as a dependency). Defaults to walking up from the current directory.

jitx support request

Send a ticket title and description after confirmation. Missing fields are prompted interactively. --description and --description-stdin are mutually exclusive. --yes bypasses confirmation and is required in JSON mode.

Without --submit, send only ticket text. An explicit --project also creates a local bundle, without uploading it. With --submit, collect and upload a bundle and attach it to the ticket. The submitted bundle is temporary and is removed afterward; run support bundle separately to retain a local copy. In JSON mode, supply a nonblank title and description (or --description-stdin) as well as --yes; missing fields produce a usage error.

jitx support request --title "Build failure" --description "Steps to reproduce…"

Argument / option	Default	Meaning
--title, -t	unset	Ticket title. Prompted if omitted.
--description, -d	unset	Ticket body. Prompted if omitted.
--description-stdin	false	Read the ticket body from stdin. Mutually exclusive with –description; useful for multi-line text piped in from another tool (e.g. the VS Code extension).
--submit	false	Build a diagnostics bundle and upload it to JITX, attaching it to the ticket. Off by default — the ticket is filed with your text only.
--yes, -y	false	Skip the confirmation prompt before filing. Required in JSON mode.
--project	unset	JITX project root (directory containing pyproject.toml with jitx as a dependency). Defaults to walking up from the current directory.