Help Command

This guide explains how to use the DeepLint help system to get information about available commands and options.

Overview

DeepLint provides a comprehensive help system that allows you to:

• View a list of all available commands

• Get detailed information about specific commands

• See examples of how to use each command

• Understand command options and their default values

Basic Usage

To display general help information, use the help command:

deeplint help

This will display:

• A list of all available commands with descriptions

• Default command options

• Global options that apply to all commands

• Examples of common usage patterns

You can also use the --help flag or the -h shorthand to display help information:

deeplint --help

Command-Specific Help

To get detailed help for a specific command, use:

deeplint help <command>

For example, to get help for the init command:

deeplint help init

This will display:

• Command description

• Usage information

• Available options with descriptions and default values

• Command aliases

• Examples of how to use the command

You can also get help for a command by using the --help flag with the command:

deeplint init --help

Default Command Help

DeepLint's default command runs when you don't specify a command (just deeplint). To get help for the default command:

deeplint help default

This will show you all the options available for the default command, such as:

OPTIONS
  --context=<type>   Context depth (light, deep)      [default: light]
  --debug            Enable debug output              [default: false]
  --dump=<file>      Dump context to a file
  --unstaged         Include unstaged changes         [default: false]
  --help, -h         Display help for this command

Help Command Aliases

The help command has the following aliases:

• h

• ?

You can use these aliases instead of help:

deeplint h init
deeplint ? init

Examples

Here are some examples of using the help command:

General Help

deeplint help

Displays a list of all available commands and general usage information.

Command-Specific Help

deeplint help init

Displays detailed help for the init command, including options, aliases, and examples.

Default Command Help

deeplint help default

Displays help for the default command that runs when no command is specified.

Using --help Flag

deeplint init --help

Displays help for the init command.

Understanding Help Output

The help output is organized into sections:

USAGE

Shows the command syntax:

USAGE
  $ deeplint init [options]

OPTIONS

Lists all available options for the command:

OPTIONS
  --force, -f        Overwrite existing config    [default: false]
  --help, -h         Display help for this command

Each option includes:

• The option name and any aliases

• A description of what the option does

• The default value (if applicable)

ALIASES

Lists alternative names for the command:

ALIASES
  $ deeplint initialize
  $ deeplint create-config

EXAMPLES

Provides practical examples of using the command:

EXAMPLES
  $ deeplint init              Create a new configuration
  $ deeplint init --force      Overwrite existing configuration

Next Steps

Now that you understand how to use the help system, you can:

1. Explore the available commands using deeplint help

2. Learn about specific commands using deeplint help <command>

3. Understand the options for the default command using deeplint help default

For more information about DeepLint's configuration, see the Configuration guide.