Reference CLI
Command-line interface reference for reference.do - API reference and technical docs
Reference CLI
API reference and technical docs
Installation
# Install globally
npm install -g do
# Or use via npx
npx do --versionQuick Start
# Basic usage
do docs reference generate ./srcCommands
Main Command
do docs reference generate ./srcDescription: API reference and technical docs
Usage:
do reference [options]Options
Global Options
--help, -h- Show help--version, -v- Show version--verbose- Verbose output--quiet, -q- Quiet mode--json- JSON output--config <file>- Config file path
Command-Specific Options
do reference \
--option1=value1 \
--option2=value2 \
--verboseUsage Examples
Basic Example
# Simple usage
do docs reference generate ./srcWith Options
# With configuration
do docs reference generate ./src --verbose --jsonInteractive Mode
# Interactive prompts
do reference --interactiveBatch Operations
# Process multiple items
do reference --batch items.jsonPipeline Integration
# Use with pipes
cat data.json | do reference --stdin | jq '.'Configuration
Config File
Create .doconfig in your project:
{
"reference": {
"option1": "value1",
"option2": "value2"
}
}Environment Variables
export DO_REFERENCE_OPTION1=value1
export DO_REFERENCE_OPTION2=value2
do docs reference generate ./srcOutput Formats
Default Output
do docs reference generate ./src
# ✓ Operation completed
# Result: ...JSON Output
do docs reference generate ./src --json
# {
# "success": true,
# "result": { ... }
# }Verbose Output
do docs reference generate ./src --verbose
# → Starting operation...
# → Processing...
# → Completed in 1.2sScripting
Bash Scripts
#!/bin/bash
# Check if successful
if do docs reference generate ./src; then
echo "Success!"
else
echo "Failed!"
exit 1
fiCI/CD Integration
# GitHub Actions
- name: Run Reference
run: |
do docs reference generate ./src \
--config prod.json \
--quietError Handling
Exit Codes
0- Success1- General error2- Invalid arguments3- Timeout4- Not found
Error Messages
# Capture errors
do docs reference generate ./src 2>errors.log
# Handle errors
if ! do docs reference generate ./src; then
echo "Error occurred, check errors.log"
exit 1
fiDebugging
# Debug mode
DEBUG=* do docs reference generate ./src
# Dry run
do docs reference generate ./src --dry-run
# Verbose + timing
time do docs reference generate ./src --verboseBest Practices
- Use Config Files - Store configuration in
.doconfig - Environment Variables - Use for sensitive data
- Error Handling - Check exit codes in scripts
- JSON Output - Use
--jsonfor parsing results - Verbose Mode - Use
--verbosefor debugging