Building with SettleMint/SettleMint CLI/Commands/Platform

List

Usage: settlemint platform list|ls [options] [command]

List resources in the SettleMint platform

Options:
-h, --help display help for command

Commands:
applications|a [options] List applications
services|s [options] List the application services
workspaces|w [options] List workspaces
help [command] display help for command

Applications

Usage: settlemint platform list applications|a 
Examples:

# List applications
$ settlemint platform list applications

# List applications in wide format with more information
$ settlemint platform list applications -o wide

# List applications in JSON format
$ settlemint platform list applications -o json > applications.json

# List applications in YAML format
$ settlemint platform list applications -o yaml > applications.yaml

List applications

Options:
-w, --workspace <workspace> The workspace unique name to list applications
for (defaults to workspace from env)
-o, --output <output> The output format (choices: "wide", "json",
"yaml")
-h, --help display help for command

Services

Usage: settlemint platform list services|s 
Examples:

# List the application services
$ settlemint platform list services

# List the application services in wide format with more information (such as console url)
$ settlemint platform list services -o wide

# List the application services in JSON format
$ settlemint platform list services -o json > services.json

# List the application services in YAML format
$ settlemint platform list services -o yaml > services.yaml

# List the application services for a specific application
$ settlemint platform list services --application my-app

# List the application services for a specific application and type
$ settlemint platform list services --application my-app --type middleware

# List the application services for multiple types
$ settlemint platform list services --type blockchain-network blockchain-node middleware

List the application services

Options:
--app, --application <application> The application unique name to list the
services in (defaults to application from
env)
-t, --type <type...> The type(s) of service to list (choices:
"blockchain-network", "blockchain-node",
"load-balancer", "custom-deployment",
"insights", "integration-tool",
"middleware", "private-key", "storage")
-o, --output <output> The output format (choices: "wide",
"json", "yaml")
-h, --help display help for command

Workspaces

Usage: settlemint platform list workspaces|w 
Examples:

# List workspaces
$ settlemint platform list workspaces

# List workspaces in wide format with more information
$ settlemint platform list workspaces -o wide

# List workspaces in JSON format
$ settlemint platform list workspaces -o json > workspaces.json

# List workspaces in YAML format
$ settlemint platform list workspaces -o yaml > workspaces.yaml

List workspaces

Options:
-o, --output <output> The output format (choices: "wide", "json", "yaml")
-h, --help display help for command

On this page