Crate firedbg_cli
source ·Expand description
FireDBG Command Line Interface
firedbg-cli
is a CLI to invoke all FireDBG operations.
Cargo Workspace
The firedbg
command can only act on Cargo Workspace. If you have a simple dependency free rust file, you still need to put it under a cargo workspace for firedbg
to work properly.
There are two ways to tell firedbg
where is the root directory of a cargo workspace:
- By default, the current directory will be the root directory of a cargo workspace
- Or, overriding it with
--workspace-root
option, i.e.firedbg --workspace-root <WORKSPACE-ROOT>
Common Subcommands
cache
: Parse all.rs
source files in the current workspaceclean
: Cleanup thefiredbg/
folderlist-target
: List all runnable targetsrun
: Run a binary target with debugging enabledexample
: Run an example with debugging enabledtest
: Run an integrated test with debugging enabledunit-test
: Run a unit test with debugging enabledindex
: Run indexer on the latest run and save it as a.sqlite
db filelist-run
: List allfiredbg
runsopen
: Open debugger view in VS Codehelp
: Print help message or the help of the given subcommand(s)
You can get the help messages by appending the --help
flag.
The firedbg.toml
Config File
By default FireDBG will only trace the function calls of the debugging package. If you want to trace other packages in your local workspace, you will need to create a firedbg.toml
config file on your workspace root.
[workspace.members]
quicksort = { trace = "full" }
# Syntax: <PACKAGE> = { trace = "<full | none>" }