Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 1.05 KB

HELP.md

File metadata and controls

43 lines (24 loc) · 1.05 KB

Command-Line Help for forest

This document contains the help content for the forest command-line program.

Command Overview:

forest

Explore and summarise Rust projects

Usage: forest [OPTIONS] <project_dir>

Copyright (c) 2025 Nicholas D. Crosbie

Arguments:
  • <PROJECT_DIR> — The directory containing the Rust project to analyse
Options:

  • --output <FILE> — Write results to the specified file instead of stdout

  • --format <FORMAT> — Output format (json, csv, or text)

    Default value: text

    Possible values: json, csv, text

  • -s, --sort — Sort variable names alphabetically

  • --tree — Generate a tree-like representation of the project's structure

  • --link — Include VSCode-compatible link to the source in the output

  • --markdown-help — Generate a markdown version of the help text

This document was generated automatically by clap-markdown.