swcli project

Overview

swcli [GLOBAL OPTIONS] project [OPTIONS] <SUBCOMMAND> [ARGS]...

The project command includes the following subcommands:

• create(add, new)
• info
• list(ls)
• recover
• remove(ls)
• use(select)

swcli project create

swcli [GLOBAL OPTIONS] project create <PROJECT>

project create creates a new project.

PROJECT is a project URI.

swcli project info

swcli [GLOBAL OPTIONS] project info [OPTIONS] <PROJECT>

project info outputs detailed information about the specified Starwhale Project.

PROJECT is a project URI.

swcli project list

swcli [GLOBAL OPTIONS] project list [OPTIONS]

project list shows all Starwhale Projects.

Option	Required	Type	Defaults	Description
--instance	N	String		The URI of the instance to list. If this option is omitted, use the default instance.
--show-removed	N	Boolean	False	If true, include projects that are removed but not garbage collected.
--page	N	Integer	1	The starting page number. Server and cloud instances only.
--size	N	Integer	20	The number of items in one page. Server and cloud instances only.

swcli project recover

swcli [GLOBAL OPTIONS] project recover [OPTIONS] <PROJECT>

project recover recovers previously removed Starwhale Projects.

PROJECT is a project URI.

Garbage-collected Starwhale Projects can not be recovered, as well as those are removed with the --force option.

swcli project remove

swcli [GLOBAL OPTIONS] project remove [OPTIONS] <PROJECT>

project remove removes the specified Starwhale Project.

PROJECT is a project URI.

Removed Starwhale Projects can be recovered by swcli project recover before garbage collection. Use the --force option to persistently remove a Starwhale Project.

Removed Starwhale Project can be listed by swcli project list --show-removed.

Option	Required	Type	Defaults	Description
--force or -f	N	Boolean	False	If true, persistently delete the Starwhale Project. It can not be recovered.

swcli project use

swcli [GLOBAL OPTIONS] project use <PROJECT>

project use make the specified project default. You must login at first to use a project on a Server/Cloud instance.