swcli job

Overview

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

The job command includes the following subcommands:

• cancel
• info
• list(ls)
• pause
• recover
• remove(rm)
• resume

swcli job cancel

swcli [GLOBAL OPTIONS] job cancel [OPTIONS] <JOB>

job cancel stops the specified job. On Standalone instance, this command only takes effect for containerized jobs.

JOB is a job URI.

Option	Required	Type	Defaults	Description
--force or -f	N	Boolean	False	If true, kill the Starwhale Job by force.

swcli job info

swcli [GLOBAL OPTIONS] job info [OPTIONS] <JOB>

job info outputs detailed information about the specified Starwhale Job.

JOB is a job URI.

Option	Required	Type	Defaults	Description
--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 job list

swcli [GLOBAL OPTIONS] job list [OPTIONS]

job list shows all Starwhale Jobs.

Option	Required	Type	Defaults	Description
--project	N	String		The URI of the project to list. Use the default project if not specified.
--show-removed or -sr	N	Boolean	False	If true, include packages 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 job pause

swcli [GLOBAL OPTIONS] job pause [OPTIONS] <JOB>

job pause pauses the specified job. Paused jobs can be resumed by job resume. On Standalone instance, this command only takes effect for containerized jobs.

JOB is a job URI.

From Starwhale's perspective, pause is almost the same as cancel, except that the job reuses the old Job id when resumed. It is job developer's responsibility to save all data periodically and load them when resumed. The job id is usually used as a key of the checkpoint.

Option	Required	Type	Defaults	Description
--force or -f	N	Boolean	False	If true, kill the Starwhale Job by force.

swcli job resume

swcli [GLOBAL OPTIONS] job resume [OPTIONS] <JOB>

job resume resumes the specified job. On Standalone instance, this command only takes effect for containerized jobs.

JOB is a job URI.