Skip to content

CLI Commands

StackPort includes a CLI for scripting and CI/CD integration.

Start the web server (default command).

Terminal window
stackport serve --port 8080
FlagDefaultDescription
--port8080Server port

Running stackport with no subcommand is equivalent to stackport serve.

Show all services with availability and resource counts.

Terminal window
stackport status
stackport status --output json
FlagDefaultDescription
--endpointenv varAWS endpoint URL
--regionus-east-1AWS region
--outputtableOutput format: table, json

Example output:

SERVICE STATUS RESOURCES
s3 active 3
dynamodb active 5
lambda active 2
sqs active 8
ec2 inactive 0
...

List resources for a specific service.

Terminal window
stackport list s3
stackport list dynamodb --output csv
stackport list lambda --output json
FlagDefaultDescription
--endpointenv varAWS endpoint URL
--regionus-east-1AWS region
--outputtableOutput format: table, json, csv

stackport describe <service> <resource_type> <resource_id>

Section titled “stackport describe <service> <resource_type> <resource_id>”

Get detailed information about a specific resource.

Terminal window
stackport describe s3 buckets my-bucket
stackport describe lambda functions my-func --output json
stackport describe sqs queues my-queue
FlagDefaultDescription
--endpointenv varAWS endpoint URL
--regionus-east-1AWS region
--outputjsonOutput format: json, table

Export all resources for a service to JSON or CSV.

Terminal window
stackport export lambda --format json
stackport export ec2 --format csv
stackport export s3 --format json > s3-backup.json
FlagDefaultDescription
--endpointenv varAWS endpoint URL
--regionus-east-1AWS region
--formatjsonOutput format: json, csv