---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx workflows jobs"
description: "The sylphx workflows jobs commands of Sylphx Workflows: every verb, with its argument, its flags and a run line."
type: reference
product: jobs
summary: "Every sylphx workflows jobs command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `jobs` commands of Sylphx Workflows, as the CLI spells them: the same
calls as [the `jobs` API page](/docs/api/jobs), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a job.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx workflows jobs get orgs/acme/projects/shop/envs/production/jobs/job
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job` · scope `workflows:read` · effect `read` · [Request, response and examples](/docs/api/jobs/get)

## list

Lists jobs.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx workflows jobs list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs` · scope `workflows:read` · effect `read` · [Request, response and examples](/docs/api/jobs/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels and filterable fields. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## create

Creates a job.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx workflows jobs create --parent orgs/acme/projects/shop/envs/production --spec.service …
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs` · scope `workflows:write` · effect `write` · [Request, response and examples](/docs/api/jobs/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.service` | `string` | The Hosting Service whose env and Secret bindings every run takes, and whose live Release image it runs unless `image` or `build` names another, so a Job never runs code the environment does not serve. Required. |
| `--spec.image` | `string` | A digest-pinned image from this org's Artifacts, in place of the service's image. Exclusive with `build`. |
| `--spec.command` | `string` | The entrypoint; empty keeps the image's. Repeat the flag for each value. |
| `--spec.args` | `string` | Arguments; a run may replace them. Repeat the flag for each value. |
| `--spec.env` | `key=value` | Environment overrides on top of the service's env and Secret bindings. Repeat the flag for each value. |
| `--spec.instance-type` | `string` | A Hosting instance type; default `standard`. |
| `--spec.timeout` | `duration` | One attempt's deadline, 10s to 24h; default 1h. |
| `--spec.max-retries` | `int` | Re-runs after a non-zero exit, 0 to 10; backoff 30s doubling. |
| `--spec.concurrency` | `enum` | What a start does while a run is active; default forbid. One of `forbid`, `queue`, `allow`. |
| `--spec.build` | `string` | A build the project declares: its latest built image, in place of the service's; the image needs no running service of its own. Exclusive with `image`. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## update

Updates a job. Runs already started keep the generation they pinned.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx workflows jobs update orgs/acme/projects/shop/envs/production/jobs/job --spec.service …
```

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job` · scope `workflows:write` · effect `write` · [Request, response and examples](/docs/api/jobs/update)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.service` | `string` | The Hosting Service whose env and Secret bindings every run takes, and whose live Release image it runs unless `image` or `build` names another, so a Job never runs code the environment does not serve. Required. |
| `--spec.image` | `string` | A digest-pinned image from this org's Artifacts, in place of the service's image. Exclusive with `build`. |
| `--spec.command` | `string` | The entrypoint; empty keeps the image's. Repeat the flag for each value. |
| `--spec.args` | `string` | Arguments; a run may replace them. Repeat the flag for each value. |
| `--spec.env` | `key=value` | Environment overrides on top of the service's env and Secret bindings. Repeat the flag for each value. |
| `--spec.instance-type` | `string` | A Hosting instance type; default `standard`. |
| `--spec.timeout` | `duration` | One attempt's deadline, 10s to 24h; default 1h. |
| `--spec.max-retries` | `int` | Re-runs after a non-zero exit, 0 to 10; backoff 30s doubling. |
| `--spec.concurrency` | `enum` | What a start does while a run is active; default forbid. One of `forbid`, `queue`, `allow`. |
| `--spec.build` | `string` | A build the project declares: its latest built image, in place of the service's; the image needs no running service of its own. Exclusive with `image`. |
| `--allow-missing` | `bool` | Create the job when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## delete

Deletes a job.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx workflows jobs delete orgs/acme/projects/shop/envs/production/jobs/job --yes
```

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/jobs/job` · scope `workflows:write` · effect `destructive` · [Request, response and examples](/docs/api/jobs/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the job does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--force` | `bool` | Also cancel active runs and delete Schedules targeting the job; without it a job with an active run or a Schedule fails with INVALID_STATE. |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |
| `--yes` | `bool` | Do not ask before this destructive call. |