Skip to main content

csph environments list

list environments

♻️ List environments associated within the requested project.

Usage​

csph environments list [flags]

Aliases​

environments list, environments ls, env list, env ls, envs list, envs ls, environment list, environment ls

Options​

Command Specific​

--deployed
deployed [true|false]
--name <string>
name

--order <string> (default "desc")

order to sort by: [asc|desc]

-p, --page <int> (default 1)

page number
--project <string>
project ID (required)
--search <string>
search term
--service <string>
service ID

-s, --size <int> (default 0)

max items to return (0 = all / server default)
--sort <string>
field to sort by

Formatting​

For more information about formatting options, see Formatting.

--fields <strings>
output JSON with the specified fields
--jq <string>
filter JSON output with jq expression

-o, --output <string>

output format: [table|plain|csv|json|yaml]
--template <string>
format JSON using a Go template

Available Fields​

active, created_at, custom_domain, default_url_disabled, deletion, deploy_policy, deployment_count, deployments, domain_path, domain_paths, expires_at, id, kind, name, network_access, network_policy, object, preview, project_id, region, source_environment_id, sub_domain, ttl_hours, updated_at

Inherited​

--config <string>
config file (default is $HOME/.config/computesphere/configuration.yaml)
--debug
enable debug logging

-h, --help

show this help message

-i, --interactive

run interactively (prompts, pickers, table browser)
--log-level <string>
log level: [trace|debug|info|warn|error|fatal|panic|disabled||api]
--no-color
disable color output
--no-input
disable interactive mode

Examples​

# start an interactive session to list environments
> csph environment list

# start an interactive session to list environments but output as JSON
> csph environment list --output json

# list environments in a project
> csph environment list --project <project-id>

# ... with a specific name
> csph environment list --project <project-id> --name my-env

# output as CSV
> csph environment list --project <project-id> --output csv

# output as JSON, with a specific fields to display
> csph environment list --project <project-id> --output json --fields id,name,region

See also​