sylphx access projects
Every sylphx access projects command: its argument, its flags and a run line.
The projects commands of Sylphx Access, as the CLI spells them: the same
calls as the projects API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
get
Gets a project.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access projects get orgs/acme/projects/shopGET https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:read · effect read · Request, response and examples
list
Lists projects in an org. Filter by spec.declared_key to resolve a declared project, then list its envs and Hosting services by resource name. Results default to 50 per page (maximum 1000), ordered by slug then name. Non-empty order_by is refused until custom ordering is supported.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx access projects list orgs/acmeGET https://api.sylphx.com/v1/orgs/acme/projects · scope access:read · effect read · Request, response and examples
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 spec fields, and Ready. |
--order-by | string | Custom ordering is not supported; leave empty. |
create
Creates a project. Access assigns the id.
CLI
sylphx access projects create --parent orgs/acme --spec.slug …POST https://api.sylphx.com/v1/orgs/acme/projects · scope access:admin · effect write · Request, response and examples
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.slug | string | Unique within the org. Required. |
--spec.limits.ai-spend.monthly-usd-minor | int | Most spend per calendar month, in USD cents. |
--spec.limits.ai-spend.daily-usd-minor | int | Most spend per calendar day, in USD cents. |
--spec.limits.requests-per-minute | int | Requests per minute. |
--spec.limits.ai-tokens-per-minute | int | Sylphx AI tokens per minute, input and output together. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--region | string | The region the project lives in for its whole life. A region that cannot take new projects is refused, never replaced. Unset uses the default region. |
--synthetic-ttl | duration | Marks the project synthetic (a test, proof, probe or fixture) and how long it lives: whole hours in seconds, from 3600s to 2592000s (30 days), for example 86400s for a day. Once that has passed, the project is retired: marked pending deletion for a recovery window, then deleted only if it is quiet and holds no unbacked data. Unset is an ordinary project, which never expires. |
update
Updates a project.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access projects update orgs/acme/projects/shop --spec.slug …PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:admin · effect write · Request, response and examples
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.slug | string | Unique within the org. Required. |
--spec.limits.ai-spend.monthly-usd-minor | int | Most spend per calendar month, in USD cents. |
--spec.limits.ai-spend.daily-usd-minor | int | Most spend per calendar day, in USD cents. |
--spec.limits.requests-per-minute | int | Requests per minute. |
--spec.limits.ai-tokens-per-minute | int | Sylphx AI tokens per minute, input and output together. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
delete
Deletes a project.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access projects delete orgs/acme/projects/shop --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:admin · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--force | bool | Also delete every child Resource; without it a parent with children fails with FAILED_PRECONDITION. |
--yes | bool | Do not ask before this destructive call. |