CLI command reference

Run commands in your project’s Python environment after installation and project setup. Use uv run jitx … if that environment is managed by uv and is not activated.

Options belong to the command that declares them. Global options precede the command group; command options follow the command. For example:

jitx --format json design find
jitx --logging DEBUG design build myboard.main.Myboard --dry --no-dependency-check

Commands with --project search upward from the current directory for a pyproject.toml declaring a jitx dependency when that option is omitted. Selecting a project does not install it or change the active Python environment. Install design projects in editable mode so imports resolve from any directory.

• Project commands
• Runtime commands
• Authentication commands
• Design commands
• Export commands
• Support commands
• Interactive editor commands

jitx

With no command, print help.

--help is available at every command and group and exits without performing the command. For example, jitx design build --help shows build-specific options. --format json selects structured output for commands using the CLI formatter; help and some diagnostic/export output remain text. Treat the exit status as the success indicator and inspect command-specific status fields too. Normal command failures use exit status 1; argument/usage errors generally use 2. Commands producing several results may emit multiple JSON records rather than one JSON array. Runtime installation with --progress sends progress to stderr.

jitx --version
jitx --format json --version
jitx --show-completion
jitx --install-completion

Completion defaults to the detected shell; installation writes shell configuration. Start a new shell afterward. Logging defaults to INFO; repeat --logger NAME=LEVEL to override individual loggers, for example --logger httpx=DEBUG.

Argument / option	Default	Meaning
--version	false	Show the installed jitx version and exit.
--format	unset	Output formatter: text (default when unset) or json. Values: json, text.
--logging	INFO	Default logging threshold. Values: DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL.
--logger, -l	unset	Per-logger level override as NAME=LEVEL (repeatable).
--install-completion	unset	Install completion for the current shell.
--show-completion	unset	Show completion for the current shell, to copy it or customize the installation.