DocInsight CLI and local server
console
$ docinsight --help
DocInsight CLI and local server
Usage: docinsight [OPTIONS] <COMMAND>
Commands:
init Create a new project manifest
check Check documentation projects, content, and sources
build Build configured documentation outputs
clean Remove generated files owned by the last build
open Open generated documentation output
license Show and manage license information
Options:
-h, --help
Print help
-V, --version
Print version
Output Options:
-q, --quiet
Suppress all messages except for warnings and errors
-v, --verbose...
Increase output detail (-v for verbose, -vv for full operational details)
Terminal Options:
--color <WHEN>
When to use terminal colors
[possible values: auto, always, never]
--no-color
Disable terminal colors
--progress <WHEN>
When to display progress indicators
[possible values: auto, always, never]
--no-progress
Disable progress indicators
--hyperlinks <WHEN>
When to emit terminal hyperlinks
[possible values: auto, always, never]
--no-hyperlinks
Disable terminal hyperlinks
Interaction Options:
--no-input
Never prompt for user input
Logging Options:
--log-file <PATH>
Write diagnostic logs to a file
[env: DOCINSIGHT_LOG_FILE=]
--log-level <LEVEL>
Set the minimum diagnostic log level
[env: DOCINSIGHT_LOG_LEVEL=]
[possible values: error, warn, info, debug, trace]