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

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

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

**Not available yet.** Sylphx Build is declared in the registry but no backend serves it: every command answers `501` with the problem code `UNIMPLEMENTED`.

## get

Gets a build.

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

**CLI**

```bash
sylphx build builds get orgs/acme/projects/shop/builds/build
```

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

## list

Lists builds in a project.

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

**CLI**

```bash
sylphx build builds list orgs/acme/projects/shop
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds` · scope `build:read` · effect `read` · [Request, response and examples](/docs/api/builds/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, filterable fields, and Ready. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## create

Creates a build. The Operation is done when the controller settles it.

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

**CLI**

```bash
sylphx build builds create --parent orgs/acme/projects/shop --spec.source.source-link … --spec.source.commit …
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds` · scope `build:write` · effect `write` · [Request, response and examples](/docs/api/builds/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.source.source-link` | `string` | The Hosting SourceLink naming the repository and its Connection. Required. |
| `--spec.source.commit` | `string` | The full commit SHA to build. Required. |
| `--spec.source.root-directory` | `string` | The directory inside the repository to build; default the root. |
| `--spec.dockerfile` | `string` | A Dockerfile path relative to the root directory; unset lets the zero- config frontend detect the stack. |
| `--spec.target` | `string` | The Dockerfile stage to build. |
| `--spec.build-class` | `string` | The class, `sylphx-<os>-<size>`; default `sylphx-linux-standard`. |
| `--spec.build-args` | `key=value` | Build arguments. Secret values bind through Sylphx Secrets, never here. Repeat the flag for each value. |
| `--spec.cache` | `string` | The BuildCache to read and write; default the project's `default` cache. |
| `--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. |

## cancel

Cancels a queued or running Build; its lease is released and nothing is published.

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

**CLI**

```bash
sylphx build builds cancel orgs/acme/projects/shop/builds/build --yes
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build:cancel` · scope `build:write` · effect `destructive` · [Request, response and examples](/docs/api/builds/cancel)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Act only if the current etag matches. |
| `--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. |
| `--yes` | `bool` | Do not ask before this destructive call. |