Rust CLI Troubleshooting: Tests, Doctests, and Documentation

Rust CLI•Permalink

Commands for debugging failing tests, capturing output, isolating flaky cases, and fixing documentation-generation issues in Rust CLI projects.

View

Standard Detailed Compact

Export

Copy the compact sheet, download it, or print it.

Download

`D` dense toggle · `C` copy all

Test debugging workflows

Isolate failing tests and inspect runtime output.

Run all tests

Build and run the full test suite.

bashANYcargotest

↗#

bash

cargo test

Notes

The baseline command for reproducing a failing test run.

Run a subset of tests

Filter tests by name substring.

bashANYcargotestfilter

↗#

bash

cargo test parse_args

Notes

Useful when tightening the debug loop around one failing CLI behavior.

Show test output

Print stdout/stderr from tests.

bashANYcargotestnocapture

↗#

bash

cargo test -- --nocapture

Notes

Great for CLI tools whose tests assert output or side effects.

Run tests serially

Use one test thread to reduce races.

bashANYcargotestthreads

↗#

bash

cargo test -- --test-threads=1

Notes

Helpful for flaky tests involving ports, temp files, or global process state.

Run one exact test

Use the exact test name through the test harness.

bashANYcargotestexact

↗#

bash

cargo test parse_args_handles_help -- --exact

Notes

Useful when multiple test names share the same substring.

Test one workspace package

Limit the run to a selected member.

bashANYcargotestworkspace

↗#

bash

cargo test -p my-cli

Notes

Avoids noise from unrelated packages in a workspace.

Docs and doctests

Generate docs, open local docs, and clean up stale output.

Build documentation

Generate local docs for the package and dependencies.

bashANYcargodocrustdoc

↗#

bash

cargo doc

Notes

Useful when troubleshooting rustdoc failures or missing public API docs.

Build and open local docs

Generate documentation and launch it in a browser.

bashANYcargodocopen

↗#

bash

cargo doc --open

Notes

Good for quickly verifying which public items and examples are appearing.

Run doctests only

Focus on failures in documentation examples.

bashANYcargotestdoctest

↗#

bash

cargo test --doc

Notes

Useful when only code examples inside docs are failing.

Clean stale docs and artifacts

Remove target output before a fresh doc build.

bashANYcargocleandoc

↗#

bash

cargo clean

Notes

Useful because documentation output can accumulate in `target/doc` across runs.

Hide setup lines in doctests

Keep examples readable while still compiling.

rustANYrustdoctestdocs

↗#

rust

/// ```
/// # use std::path::Path;
/// let path = Path::new("Cargo.toml");
/// assert!(path.exists());
/// ```

Notes

Hidden `#` lines are a common technique for making doctests compile without cluttering the displayed example.

More in Rust CLI

Rust CLI Troubleshooting: CI, Environment, Build Scripts, and Publishing

Commands for debugging CI failures, environment mismatches, build script output, installation problems, and publish checks in Rust CLI projects.

Rust CLI Troubleshooting: rustup, Toolchains, Components, and Targets

Commands for fixing toolchain mismatches, missing components, and cross-compilation target issues in Rust CLI projects.

Rust CLI Troubleshooting: Dependencies, Features, and Lockfiles

Commands for analyzing dependency trees, feature activation, duplicate crates, and lockfile behavior in Rust CLI projects.

Rust CLI Troubleshooting: Manifest, Packages, and Workspaces

Commands and examples for debugging Cargo.toml issues, package selection mistakes, and workspace confusion in Rust CLI repos.

Rust CLI Troubleshooting: Build Errors and Diagnostics

Commands for investigating compiler errors, Cargo diagnostics, verbose output, and fix suggestions in Rust CLI projects.

Rust CLI Cargo Config, Environment, Docs, and Debugging

Cargo configuration, environment variables, docs generation, and troubleshooting commands for Rust CLI development.

Recommended next

No recommendations yet.

Browse all sheets →