Skip to main content

crowdin screenshot upload

Description​

Add screenshot or update an existing one with the same name

Synopsis​

crowdin screenshot upload <file> [OPTIONS]

Arguments​

<file>
File path to add

Options​

--auto-tag
Choose whether or not to tag screenshot automatically

-f, --file=…
Path to the source file in Crowdin. Requires the '--auto-tag' to be passed

-b, --branch=…
Branch name. Requires the '--auto-tag' to be passed

--label=…
Attach labels to screenshot (multiple labels can be specified)

-d, --directory=…
Path to the directory in Crowdin. Requires the '--auto-tag' to be passed

-h, --help
Display help message and exit

Config Options​

-T, --token=…
Personal access token required for authentication

--base-url=…
Base URL of Crowdin server for API requests execution

--base-path=…
Path to your project directory on a local machine

-i, --project-id=…
Numeric ID of the project

Global Options​

-v, --verbose
Provide more information about the command execution

-c, --config=…
Specify a path to the configuration file

--identity=…
Specify a path to user-specific credentials

--no-colors
Disable colors and styles

--no-progress
Disable progress on executed command

-o, --output=…
Change output format (choices: "json", "toon", "plain")

Upsert behavior​

The command is an upsert, not a plain add. The screenshot's identity is the basename of the local file (ui/login.png and mobile/login.png are both login.png), so re-running the command with the same file name replaces the existing screenshot's image in place, keeping its id, its position in the project and — unless --auto-tag is passed — its tags. That is what makes scripted uploads idempotent.

If several screenshots share the same name, the oldest one is updated and a warning is printed.

Tags​

Without --auto-tag, existing tags are preserved when the image is replaced.

With --auto-tag, all existing tags of the screenshot are removed and re-derived by OCR. Manually placed or coordinate-accurate tags are lost. If auto-tagging is already running for the project, the image is still updated and a warning is printed instead of the tags being applied.

Labels​

--label sets the screenshot's labels on both create and update, replacing any labels the existing screenshot had. Labels that don't exist yet are created.