Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

get
list
create
update
delete
sync
export

Reference

sylphx localization catalogs

Every sylphx localization catalogs command: its argument, its flags and a run line.

Checked 2026-09-28

The catalogs commands of Sylphx Localization, as the CLI spells them: the same calls as the catalogs API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#get

Gets a catalog.

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

CLI

Shell

sylphx localization catalogs get orgs/acme/projects/shop/envs/production/catalogs/catalog

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog · scope localization:read · effect read · Request, response and examples

#list

Lists catalogs.

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

CLI

Shell

sylphx localization catalogs list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs · scope localization: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 and filterable fields.
`--order-by`	`string`	AIP-132 ordering over filterable fields.

#create

Creates a catalog.

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

CLI

Shell

sylphx localization catalogs create --parent orgs/acme/projects/shop/envs/production --spec.source-locale …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs · scope localization:write · 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.source-locale`	`string`	The locale the source texts are written in, a BCP 47 tag such as `en`. Required.
`--spec.target-locales`	`string`	The locales to translate into, BCP 47 tags. `zh-Hant-HK` and `zh-Hant-TW` are separate locales. At most 60, each once. Repeat the flag for each value.
`--spec.pseudo-locales`	`enum`	Pseudo-locales to generate at export. They are never stored or translated. Repeat the flag for each value. One of `accented`, `bidi`, `wide`.
`--spec.tone`	`string`	The brand voice every translation follows, at most 2000 characters.
`--spec.locale-guidance`	`key=value`	Extra instructions per target locale, for example the vocabulary of a region. Keys are target locales; at most 60 entries, each at most 2000 characters. Repeat the flag for each value.
`--spec.glossaries`	`string`	The glossaries this catalog applies, as Glossary names; at most 10. Repeat the flag for each value.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#update

Updates a catalog.

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

CLI

Shell

sylphx localization catalogs update orgs/acme/projects/shop/envs/production/catalogs/catalog --spec.source-locale …

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog · scope localization:write · 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.source-locale`	`string`	The locale the source texts are written in, a BCP 47 tag such as `en`. Required.
`--spec.target-locales`	`string`	The locales to translate into, BCP 47 tags. `zh-Hant-HK` and `zh-Hant-TW` are separate locales. At most 60, each once. Repeat the flag for each value.
`--spec.pseudo-locales`	`enum`	Pseudo-locales to generate at export. They are never stored or translated. Repeat the flag for each value. One of `accented`, `bidi`, `wide`.
`--spec.tone`	`string`	The brand voice every translation follows, at most 2000 characters.
`--spec.locale-guidance`	`key=value`	Extra instructions per target locale, for example the vocabulary of a region. Keys are target locales; at most 60 entries, each at most 2000 characters. Repeat the flag for each value.
`--spec.glossaries`	`string`	The glossaries this catalog applies, as Glossary names; at most 10. Repeat the flag for each value.
`--allow-missing`	`bool`	Create the catalog when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#delete

Deletes a catalog.

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

CLI

Shell

sylphx localization catalogs delete orgs/acme/projects/shop/envs/production/catalogs/catalog --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog · scope localization:write · effect destructive · Request, response and examples

Flags

Flag	Type	What it does
`--etag`	`string`	Delete only if the current etag matches.
`--allow-missing`	`bool`	Succeed when the catalog does not exist.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--force`	`bool`	Also delete the catalog's entries; without it, a catalog that has entries is refused with `INVALID_STATE`.
`--yes`	`bool`	Do not ask before this destructive call.

#sync

Reads the source files and the committed translations into the catalog, then translates what is new or stale. Each call is idempotent and works within a bounded time; call again until pending is 0.

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

CLI

Shell

sylphx localization catalogs sync orgs/acme/projects/shop/envs/production/catalogs/catalog

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog:sync · scope localization:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--format`	`enum`	The format of the files. Required. One of `sylphx_json`, `icu_json`, `gettext_po`, `xliff2`.
`--sources`	`json`	The source-locale files; 1 to 500. Required. Repeat the flag for each value.
`--translations`	`json`	The committed target-locale files; at most 10000. A text that differs from the service's last export is recorded as a pinned human override. Repeat the flag for each value.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#export

Returns the catalog's files per locale in the requested format, with the QA report. A read with a request body, like a query.

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

CLI

Shell

sylphx localization catalogs export orgs/acme/projects/shop/envs/production/catalogs/catalog

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog:export · scope localization:read · effect read · Request, response and examples

Flags

Flag	Type	What it does
`--format`	`enum`	The format of the files. Required. One of `sylphx_json`, `icu_json`, `gettext_po`, `xliff2`.
`--locales`	`string`	The locales to export; default every target locale and the pseudo-locales. Repeat the flag for each value.
`--source-fallback`	`bool`	Emit the source text for keys that have no passing translation, for runtimes that do not fall back to the source themselves.

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links