Skip to content

CLI Reference

Usage

Run your Python script with debugging tools enabled using the dojo run command:

dojo run my_script.py

Check your progress and current belt with:

dojo belt

You can optionally set configuration, verbose mode, and specify the debugger type. Both script files and modules are supported:

dojo run --debugger ipdb --config dojo.toml --verbose --module my_module

dojo

Run a Python script or module with debugging tools installed.

Usage

dojo [OPTIONS] COMMAND [ARGS]…

Arguments

No arguments available

Options

Name Description Required Default
–install-completion Install completion for the current shell. No -
–show-completion Show completion for the current shell, to copy it or customize the installation. No -
–help Show this message and exit. No -

Commands

Name Description
belt Show your current Dojo Belt and stats.
run Run a Python script or module with…

Subcommands

dojo belt

Show your current Dojo Belt and stats.

Usage

dojo belt [OPTIONS]

Arguments

No arguments available

Options

Name Description Required Default
-c, –config PATH Show configuration No -
–help Show this message and exit. No -

dojo run

Run a Python script or module with debugging tools installed.

Usage

dojo run OPTIONS

Arguments

Name Description Required
target The target script or module to debug. No

Options

Name Description Required Default
-c, –config PATH Show configuration No -
-d, –debugger [debugpy|ipdb|pdb|pudb] Specify the debugger to use No -
-v, –verbose Enable verbose output No -
-m, –module Run a module No -
-e, –exec Run a command No -
–help Show this message and exit. No -