Get help with Incident Response CLI
View available commands, command options, and examples. Generate debug logging output.
Before you begin
Role required: Responder, Manager, or Administrator
About this task
In addition to the debug logging output option, the CLI logs all command executions to a log file at the following locations:
- Linux and Mac: ~/.lightstep/.logs.
- Windows:%USERPROFILE%\.lightstep\.logs.
Procedure
-
To see the available commands and arguments, open your system's command-line
tool and enter the command you need help with, followed by the
--help
argument.The following example displays help for the available top-level commands.
$ lightstep --help
The following example displays the available profile-specific commands.
$ lightstep configure profile --help
The CLI displays help for the requested command divided into eight sections:
- Name
-
The name of the command.
Name set
- Description
-
The description of what the command does and its return values.
Description Configure connection profiles. This command is interactive and will prompt you for each configuration value.
- Synopsis
-
The basic syntax for using the command and its options.
Synopsis lightstep configure profile set [arguments]
- Available commands
-
The commands available under the current command group.
Available Commands list : Lists the configured connection profiles. refresh : Updates the available commands from the instance for the given profile. remove : Removes the specified connection profile. set : Configures connection profiles in order to communicate with an instance.
- Command groups
-
The command groups available under the current command group.
Command Groups profile : Set, view, and remove connection profiles.
- Arguments
-
A description of each of the arguments that the command accepts.
Arguments -p, --profile string : Use a specific connection profile when executing a command.
- Global arguments
-
The global arguments that the command accepts.
Global Arguments -d, --debug Print logs to console. -h, --help Display detailed help information. -o, --output string Set the format for printing command output.
-
To generate debug logging output, open your system's command-line tool and
enter the command you want to debug, followed by the
--debug
argument.The following example generates debug logging output when trying to perform the operation.
lightstep alert create --desc ‘VPN Service breakdown’ --priority 1 --source ‘VPN Client’ --debug
The CLI generates debug logging output when executing the command.