Skip to content

commands.md

Latest commit

 

History

History
71 lines (51 loc) · 2.48 KB

commands.md

File metadata and controls

71 lines (51 loc) · 2.48 KB

Stack Commands

Overview for all stack commands and subcommands. Please see the individual reference pages for documentation on each command, linked below.

Overview

Stack uses a command/subcommand structure for organizing functionality. Commands are grouped by their primary function.

Global Options

These options can be used with any command:

Option Type Description Default
--log-file TEXT Log to file (default stdout/stderr) -
--debug FLAG Enable debug options From config
--profile TEXT Configuration profile to use config
--verbose FLAG Log extra details False
--quiet FLAG Suppress unnecessary log output False
-h, --help FLAG Show help message -

Environment Variables

Variable Description
STACK_CONFIG_PROFILE Default configuration profile
STACK_REPO_BASE_DIR Base directory for repositories
STACK_DEBUG Enable debug mode
STACK_LOG_LEVEL Set log level
STACK_USE_BUILTIN_STACK Use built-in stack definitions

Configuration Files

[Placeholder: Add information about configuration file locations and formats]

Getting Help

For help with any command:

stack COMMAND --help
stack COMMAND SUBCOMMAND --help

Command Categories

📦 Repository & Build Management

  • fetch - Clone repositories and fetch resources
  • prepare - Build or download stack containers
  • build - Build stack components (containers, etc.)

⚙️ Stack Configuration

  • init - Create a stack specification file
  • config - Manage configuration settings

🚀 Deployment & Management

  • deploy - Deploy a stack
  • manage - Manage a deployed stack (start, stop, etc.)

📊 Information & Analysis

  • list - List available stacks
  • check - Check if stack containers are ready
  • chart - Generate a mermaid graph of the stack

🌐 Web Applications

  • webapp - Build, run, and deploy webapps

🔧 Utility Commands

  • version - Print tool version
  • update - Update shiv binary from a distribution URL
  • complete - Output shell completion script (hidden)