Skip to main content

wraps status

Show an overview of all deployed Wraps services (email, SMS, CDN) in your AWS account across all configured regions.
wraps status
wraps status --account 123456789012
--account
string
AWS account ID to inspect. Defaults to the account resolved from your current credentials.

wraps destroy

Remove all Wraps-deployed infrastructure across all services (email, SMS, CDN) in your account.
wraps destroy
wraps destroy --force
wraps destroy --preview
This removes all email, SMS, and CDN infrastructure deployed by Wraps. Use service-specific destroy commands (wraps email destroy, wraps sms destroy, wraps cdn destroy) to remove individual services.
-f, --force
boolean
Skip the confirmation prompt.
--preview
boolean
Show which resources would be deleted without deleting them.

wraps console

Start a local web dashboard for viewing email events, SMS logs, and CDN stats. Opens in your browser automatically.
wraps console

# Custom port
wraps console --port 8080

# Start without opening browser
wraps console --noOpen
--port
number
Port to run the dashboard on. Defaults to a system-assigned port.
--noOpen
boolean
Start the server without opening a browser window.

wraps permissions

Print the AWS IAM permissions required to deploy and operate Wraps infrastructure. Use this to craft a minimal IAM policy for your CI/CD role or developer credentials.
# Human-readable output
wraps permissions

# JSON output (for use in IAM policy documents)
wraps permissions --json

# Filter by service
wraps permissions --service email
wraps permissions --service sms
wraps permissions --service cdn

# Filter by preset
wraps permissions --preset production
--json
boolean
Output permissions as a JSON IAM policy document.
--preset
string
Show permissions required for a specific configuration preset (starter, production, enterprise, custom).
--service
string
Show permissions for a specific service only. Accepted values: email, sms, cdn.

wraps completion

Generate a shell completion script for the wraps CLI. Pipe the output to your shell’s completion configuration.
# Bash
wraps completion >> ~/.bashrc

# Zsh
wraps completion >> ~/.zshrc

# Fish
wraps completion >> ~/.config/fish/completions/wraps.fish

wraps telemetry

Manage CLI telemetry. Telemetry collects anonymous usage data (command names, durations, error codes) to help improve the CLI. No credentials, domain names, or personal data are collected.
wraps telemetry status
wraps telemetry enable
wraps telemetry disable

wraps news

Display recent Wraps release notes and updates.
wraps news

wraps support

Print support information — links to documentation, GitHub issues, and contact options.
wraps support

wraps platform

The wraps platform commands connect your deployment to the Wraps Platform for managed event routing and IAM.

wraps platform

Show platform info and current connection status.
wraps platform

wraps platform connect

Connect your AWS account to the Wraps Platform. Sets up OIDC trust and event forwarding so the platform can receive deployment events and provide the web dashboard.
wraps platform connect
wraps platform connect --region us-east-1
wraps platform connect --force --yes
-r, --region
string
AWS region to connect.
-f, --force
boolean
Force reconnection even if a connection already exists.
-y, --yes
boolean
Skip confirmation prompts.

wraps platform update-role

Update the IAM role permissions granted to the Wraps Platform. Run this after upgrading to a new Wraps version that requires additional permissions.
wraps platform update-role
wraps platform update-role --region us-east-1 --force
-r, --region
string
AWS region of the platform connection to update.
-f, --force
boolean
Apply updates without confirmation.

Build docs developers (and LLMs) love