Skip to content

vastde_doc.md

Latest commit

 

History

History
53 lines (35 loc) · 1.3 KB

vastde_doc.md

File metadata and controls

53 lines (35 loc) · 1.3 KB
title vastde doc
description Generate CLI documentation

vastde doc

Generate CLI documentation

Synopsis

Generate markdown documentation for all CLI commands.

This command generates LLM-friendly documentation for the VAST DataEngine CLI. The documentation is organized in a hierarchical structure under docs/references/commands/.

Usage

vastde doc [options]

Examples

  # Generate documentation in the default location (./docs)
  vastde doc

  # Generate documentation in a custom location
  vastde doc --output-dir /path/to/docs

Options

Command-specific options

Flag Type Description Default
--output-dir string Output directory for generated documentation ./docs

Global options

Flag Type Description Default
--dry-run bool Simulate the operation without making actual changes to the system
-o, --output string Output format: json, yaml, human human
--silent bool Suppress UI outputs, such as spinner and success messages
-v, --verbose int Verbosity level (0-9): 0=standard, 1=verbose, 2=detailed, 3=extended, 4=debug, 5=trace 0

See Also

  • vastde - VAST DataEngine CLI