README
¶
NewStack Deploy CLI SDK
An SDK with shared TUI components, behaviours and utilities for building CLIs that handle blueprint deployments such as the Bluelink and Celerity CLIs.
Installation
go get github.com/newstack-cloud/deploy-cli-sdk
Overview
The SDK provides the following packages:
- commands — Shared CLI command factories (deploy, destroy, stage, cleanup, state) parameterised by a
CLIConfigfor branding and defaults. - tui — Bubbletea TUI models for interactive deployment workflows including staging, deploying, destroying, state import/export, and drift review.
- diagutils — Converts blueprint diagnostic errors into actionable CLI commands and registry links.
- jsonout — Structured JSON output types for headless/CI mode across all operations.
- stateio — Import/export of deploy engine state from/to local files and remote storage (S3, GCS, Azure Blob).
- config — Configuration provider with flag and environment variable binding.
- engine — Deploy engine client setup and configuration.
- styles — TUI colour palettes and styling utilities.
- headless — Headless mode flag validation and output formatting.
Documentation
Directories
¶
| Path | Synopsis |
|---|---|
|
Package commands provides shared command factory functions and configuration types for CLIs that use the Deploy CLI SDK.
|
Package commands provides shared command factory functions and configuration types for CLIs that use the Deploy CLI SDK. |
|
tui
|
|
|
deployui
Package deployui provides drift item types for the deploy command.
|
Package deployui provides drift item types for the deploy command. |
|
outpututil
Package outpututil provides shared utilities for rendering resource outputs (computed fields from spec data) across different UI components.
|
Package outpututil provides shared utilities for rendering resource outputs (computed fields from spec data) across different UI components. |
|
precommand
Package precommand provides a bubbletea sub-model that runs a PreCommandStep with a spinner and progress display, integrating into the deploy/stage TUI as an initial phase.
|
Package precommand provides a bubbletea sub-model that runs a PreCommandStep with a spinner and progress display, integrating into the deploy/stage TUI as an initial phase. |
|
preflight
Package preflight provides shared types for preflight check TUI integration.
|
Package preflight provides shared types for preflight check TUI integration. |
|
shared
Package shared provides common types and utilities for deployment TUI components.
|
Package shared provides common types and utilities for deployment TUI components. |
|
stageui
Package stageui provides drift item types for the stage command.
|
Package stageui provides drift item types for the stage command. |
|
stateutil
Package stateutil provides shared utilities for fetching and working with blueprint instance state across TUI components.
|
Package stateutil provides shared utilities for fetching and working with blueprint instance state across TUI components. |
Click to show internal directories.
Click to hide internal directories.