Skip to main content

list

list projects

📁 Search for projects. Displays a list of projects that match the search criteria. Do not provide any search criteria to list all projects.

Without --page every project in the account is listed; --size caps the list. --page N shows one page, of --size projects (at most 200) when given. --search keeps the projects whose name contains the term; with --page it only searches that page.

Usage​

csph projects list [flags]

Aliases​

projects list, projects ls, project list, project ls

Options​

Command Specific​

--account <string>
account ID

--active (default true)

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

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

order to sort by: [asc|desc]

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

page number
--search <string>
search term

-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​

account_id, active, alert_emails_enabled, alert_enabled, created_at, created_by, deletion, deployment_count, description, id, last_opened_at, name, object, service_count, sphere_count, updated_at, user_id

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 projects
> csph project list

# start an interactive session to list projects but output as CSV
> csph project list --output csv

# list projects with a specific name
> csph project list --name umbrella

# list projects within a specific account
> csph project list --account <account-id>

# the second page of 50 projects
> csph project list --account <account-id> --page 2 --size 50

# projects whose name contains "api"
> csph project list --account <account-id> --search api

See also​