help

The stacktape help command displays help information for all available Stacktape CLI commands and their options. Run it without arguments to see every command, or pass a command name (stacktape help deploy) to get detailed option documentation for that command. No API key or AWS credentials are required.

Usage

List all available commands with their descriptions:

stacktape help

Show detailed options for a specific command:

stacktape help deploy

The short alias stp works in place of stacktape:

stp help dev

Help for one command

When you pass a command name, Stacktape prints the command usage and available options, including each argument's name, whether it is required, and its description. This is the fastest way to check which flags a command accepts without leaving the terminal. stacktape <command> --help prints the same output.

stacktape help delete

Without a command name, the output lists every CLI command with its configured description, followed by hints linking to the CLI documentation and the Stacktape docs site.

Options reference

The help command accepts one optional argument. The reference below lists its name, alias, type, and whether it is required.

stacktape help <command>CLI options
--command (positional 1)string

Command

This argument has different meanings depending on the command:

  • With stacktape help, it specifies a command to show detailed help for.
  • With stacktape container shell, it specifies a command to run inside the container to start the interactive session.
-h, --helpstring

Show Help

If provided, the command will not execute and will instead print help information.

--log-level"info" | "debug" | "error"

Log Level

The level of logs to print to the console.

  • info: Basic information about the operation.
  • error: Only errors.
  • debug: Detailed information for debugging.
--quietboolean

Quiet

Hide progress, banners, success messages and hints. Command output, warnings and errors are still printed.

Examples

Get help for the dev command to see all development mode flags:

stacktape help dev

Check required and optional flags for logs:

stacktape help logs

View all commands at a glance:

stacktape help
  • version — print the installed Stacktape version.
  • init — scaffold a new Stacktape project with an interactive wizard.
  • defaults set — set system-wide default values for common flags like region and stage.