CLI reference¶

sentiary-cli init
sentiary-cli pull --dry-run
sentiary-cli pull

Use mobile downloads for Android, Compose, and Xcode examples. The reference below covers every command and option.

Invocation, credentials, and streams¶

Use sentiary-cli COMMAND [OPTIONS]. All options below belong after the command. There are no global credential, server, or JSON switches. Go flag syntax accepts --flag=value and --flag value (also single-dash forms). Boolean flags accept --flag for true or --flag=false; do not use a separate boolean word. Positional arguments are rejected. Scalar options may be repeated, with the last value winning; only pull --output accumulates multiple values. Comma-separated language lists are one scalar option.

SENTIARY_BASE_URL optionally overrides the default https://api.sentiary.com for API commands and online pulls; it also scopes the export cache. All API commands require SENTIARY_USER_API_KEY; project commands use --project-id then SENTIARY_PROJECT_ID. They do not load TOML or project keys. Authorization and project-role requirements are enforced by the API: a user key does not grant access beyond its owner's permissions. pull instead uses TOML credential precedence. init, help, and version need no network credentials; offline pull needs none.

Management and string commands write indented JSON to stdout, including mutations. export writes raw text to stdout or its output file; import reads a file or all of stdin and writes a JSON import result. pull normally prints Downloaded N file(s)., --dry-run prints a JSON array, and --json prints a protocol result. init reads line-oriented answers from stdin, sends prompts/redacted preview to stderr, and prints completion to stdout. Help and errors go to stderr. Separate stdout and stderr when scripting.

Exit 0 means success/help/version; 2 means a CLI usage error (unknown command/flag, missing CLI-required option, unexpected positional argument, invalid version arguments); 1 means another failure, including config, authentication, API, filesystem, cancellation, or init cancellation. Some required values are checked by the API client and therefore produce 1, not 2. A nonzero pull has no successful JSON result; check exit status before parsing stdout.

Examples use placeholder IDs and credentials. Commands that create, edit, remove, invite, import, or set translations mutate remote data and run without a confirmation prompt. Help examples are safe locally.

Common help and version options¶

The table for each command lists every registered option. Each row lists its type, requirement, default, and example. Options have no environment fallback unless stated. Scalar options use the last supplied value; pull --output accumulates selections. All non-pull formats use the legacy four-format list. get needs exactly one of --string-id or --key. For add, language is optional; when supplied it triggers a second request to create the initial translation. The current client ignores --translation if language is omitted. A translation failure can leave the new term created. For edit, nonempty values update fields; --clear-description / --clear-context explicitly clear them and take precedence over the corresponding text flags.

list-projects¶

List projects.

No command-specific options. Use --help for help.

sentiary-cli list-projects

get-project¶

Get a project and membership.

sentiary-cli get-project

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

create-project¶

Create a project.

sentiary-cli create-project --name=welcome

edit-project¶

Rename a project.

sentiary-cli edit-project --name=welcome

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

remove-project¶

Remove a project and its data.

sentiary-cli remove-project

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

list-languages¶

List all supported languages.

sentiary-cli list-languages

list-project-languages¶

List project languages.

sentiary-cli list-project-languages

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

add-project-language¶

Add a language to a project.

sentiary-cli add-project-language --language=cs

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

remove-project-language¶

Remove a language and its translations.

sentiary-cli remove-project-language --language=cs

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

list-project-members¶

List project members.

sentiary-cli list-project-members

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

set-project-member-role¶

Set a project member role.

sentiary-cli set-project-member-role --user-id=USER_ID --role=developer

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

remove-project-member¶

Remove a project member.

sentiary-cli remove-project-member --user-id=USER_ID

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

list-invitations¶

List invitations for the current user.

No command-specific options. Use --help for help.

sentiary-cli list-invitations

create-invitation¶

Invite a user to a project.

sentiary-cli create-invitation --user-email=developer@example.com --role=developer

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

accept-invitation¶

Accept an invitation.

sentiary-cli accept-invitation --invitation-id=INVITATION_ID

decline-invitation¶

Decline an invitation.

sentiary-cli decline-invitation --invitation-id=INVITATION_ID

list-project-invitations¶

List project invitations.

sentiary-cli list-project-invitations

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

remove-project-invitation¶

Remove a project invitation.

sentiary-cli remove-project-invitation --invitation-id=INVITATION_ID

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

list¶

List project strings.

sentiary-cli list --size=25 --include-language=en,cs --filter=NOT_TRANSLATED --filter-language=cs --order=UPDATED_DESC

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

Use pagination.next from the JSON response as the next --cursor; the CLI does not automatically fetch every page.

search¶

Search project strings.

sentiary-cli search --query=welcome --size=25

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

Use pagination.next from the JSON response as the next --cursor; the CLI does not automatically fetch every page.

get¶

Get a string by ID or key.

sentiary-cli get --key=welcome --include-language=en,cs

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

add¶

Add a string.

sentiary-cli add --name=welcome --language=cs --translation=Ahoj

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

edit¶

Edit a string.

sentiary-cli edit --string-id=STRING_ID --clear-description

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

remove¶

Remove a string.

sentiary-cli remove --string-id=STRING_ID

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

set-translation¶

Set a translation.

sentiary-cli set-translation --string-id=STRING_ID --language=cs --text=Ahoj

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

remove-translation¶

Remove a translation.

sentiary-cli remove-translation --string-id=STRING_ID --language=cs

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

info¶

Get project string information.

sentiary-cli info

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

export¶

Export project strings.

sentiary-cli export --format=json --language=cs --output=strings.json

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

init¶

Create a config for existing projects.

sentiary-cli init --directory=.

pull¶

Download configured translation outputs.

sentiary-cli pull --output=android --output=compose --dry-run

For ownership, cache location, conditional requests, cleanup, and failure semantics, see downloads. For machine requests/results see protocol. --dry-run takes preview output precedence over --json.

import¶

Import project strings.

sentiary-cli import --format=json --language=cs --input=strings.json

The example assumes SENTIARY_PROJECT_ID=PROJECT_ID; --project-id=PROJECT_ID overrides it.

Environment variables¶

Installer-only INSTALL_DIR and SENTIARY_VERSION are covered in installation.

JSON output for scripts¶

version --json reports the CLI version and supported integration protocol versions. pull --json returns a versioned list of generated files and checksums on success. pull --dry-run returns a preview array, including when combined with --json. Check the exit status before reading JSON; errors go to stderr.

--integration-request accepts a JSON file selecting outputs and validating resource roots. It cannot be combined with --output. Most CLI users do not need this option. Integration authors should use the complete protocol and JSON Schema bundle.