help command

Display help information for ao-forge commands and options.

Syntax

ao-forge --help [command]
ao-forge help [command]

Arguments

  • [command] - Specific command to show help for (optional)

Options

OptionDescriptionDefault
--verboseShow detailed help informationfalse
--jsonOutput help in JSON formatfalse
--markdownOutput help in Markdown formatfalse
--helpShow help information-

Examples

Basic Usage

# Show general help
ao-forge --help

# Show help for specific command
ao-forge --help init
ao-forge --help dev
ao-forge --help build

Alternative Syntax

# Using help command
ao-forge help
ao-forge help init
ao-forge help dev

Advanced Usage

# Show detailed help
ao-forge --help --verbose

# Output in JSON format
ao-forge --help --json

# Output in Markdown format
ao-forge --help --markdown

Help Information

General Help

# Show general help
ao-forge --help

# Output example:
# ao-forge - AO-powered application development tool
# 
# USAGE:
#   ao-forge <COMMAND>
# 
# COMMANDS:
#   init      Create a new AO-powered application
#   dev       Start development server
#   build     Build for production
#   config    Manage configuration
#   process   Manage AO processes
#   ai        AI-powered development assistance
#   version   Show version information
# 
# OPTIONS:
#   -h, --help     Show help information
#   -v, --version  Show version information

Command-Specific Help

# Show help for init command
ao-forge --help init

# Output example:
# init - Create a new AO-powered application
# 
# USAGE:
#   ao-forge init <project-name> [options]
# 
# ARGUMENTS:
#   <project-name>  The name of your project
# 
# OPTIONS:
#   --framework <framework>     Framework to use (nextjs, nuxtjs, svelte, react, vue)
#   --package-manager <manager> Package manager (npm, pnpm, yarn)
#   --template <template>       Template to use
#   --path <path>              Path to create project
#   --skip-install             Skip package installation
#   --force                    Overwrite existing files
#   -h, --help                 Show help information

Help Formats

Default Format

# Standard help output
ao-forge --help

Verbose Format

# Detailed help with examples
ao-forge --help --verbose

# Output example:
# init - Create a new AO-powered application
# 
# DESCRIPTION:
#   Creates a new AO-powered application with the specified framework
#   and template. Supports Next.js and Nuxt.js frameworks with various
#   templates including DAO, NFT Marketplace, and DeFi Protocol.
# 
# USAGE:
#   ao-forge init <project-name> [options]
# 
# ARGUMENTS:
#   <project-name>  The name of your project (required)
# 
# OPTIONS:
#   --framework <framework>     Framework to use (nextjs, nuxtjs, svelte, react, vue)
#                               Default: Interactive prompt
#   --package-manager <manager> Package manager (npm, pnpm, yarn)
#                               Default: pnpm
#   --template <template>       Template to use
#                               Default: default
#   --path <path>              Path to create project
#                               Default: Current directory
#   --skip-install             Skip package installation
#                               Default: false
#   --force                    Overwrite existing files
#                               Default: false
#   -h, --help                 Show help information
# 
# EXAMPLES:
#   ao-forge init my-app
#   ao-forge init my-app --framework nextjs
#   ao-forge init my-app --template dao

JSON Format

# JSON help output
ao-forge --help --json

# Output example:
# {
#   "command": "ao-forge",
#   "version": "1.0.0",
#   "description": "AO-powered application development tool",
#   "commands": [
#     {
#       "name": "init",
#       "description": "Create a new AO-powered application",
#       "usage": "ao-forge init <project-name> [options]",
#       "arguments": [
#         {
#           "name": "project-name",
#           "description": "The name of your project",
#           "required": true
#         }
#       ],
#       "options": [
#         {
#           "name": "--framework",
#           "description": "Framework to use (nextjs, nuxtjs, svelte, react, vue)",
#           "default": "Interactive prompt"
#         }
#       ]
#     }
#   ]
# }

Markdown Format

# Markdown help output
ao-forge --help --markdown

# Output example:
# # ao-forge
# 
# AO-powered application development tool
# 
# ## Commands
# 
# ### init
# Create a new AO-powered application
# 
# **Usage:** `ao-forge init <project-name> [options]`
# 
# **Arguments:**
# - `<project-name>` - The name of your project (required)
# 
# **Options:**
# - `--framework <framework>` - Framework to use (nextjs, nuxtjs, svelte, react, vue)
# - `--package-manager <manager>` - Package manager (npm, pnpm, yarn)

Available Commands

Core Commands

  • init - Create a new AO-powered application
  • dev - Start development server
  • build - Build for production
  • config - Manage configuration
  • process - Manage AO processes
  • ai - AI-powered development assistance
  • version - Show version information

Help Commands

  • help - Show help information
  • --help - Show help information (alternative)

Help Navigation

Command Discovery

# List all available commands
ao-forge --help

# Show help for specific command
ao-forge --help <command>

# Show help for subcommands
ao-forge --help process --help

# Search for commands
ao-forge --help --search "process"

# Search for options
ao-forge --help --search "port"

Help Customization

Custom Help Format

# Custom help format
ao-forge --help --format custom

# Help with specific sections
ao-forge --help --sections usage,examples

Help Filtering

# Show only basic commands
ao-forge --help --basic

# Show only advanced commands
ao-forge --help --advanced

# Show only framework-specific commands
ao-forge --help --framework nextjs

Help Integration

IDE Integration

# Help for IDE integration
ao-forge --help --ide vscode

# Help for specific IDE
ao-forge --help --ide webstorm

Documentation Generation

# Generate documentation
ao-forge --help --generate-docs

# Generate specific documentation
ao-forge --help --generate-docs --format markdown

Help Troubleshooting

Common Issues

  1. Command not found
    Error: Command 'invalid-command' not found
Solution: Use 'ao-forge --help' to see available commands
  2. Help not available
    Error: Help information not available
Solution: Check if ao-forge is properly installed
  3. Help format not supported
    Error: Help format 'invalid' not supported
Solution: Use 'json', 'markdown', or 'verbose' format

Help Best Practices

Using Help Effectively

  1. Start with general help to see available commands
  2. Use specific command help for detailed information
  3. Use verbose help for comprehensive information
  4. Use JSON help for programmatic access
  5. Use Markdown help for documentation

Help Documentation

  1. Keep help information up to date
  2. Provide clear examples in help text
  3. Use consistent formatting across commands
  4. Include troubleshooting information
  5. Make help accessible to all users
Table of Contents