Skip to main content

Rigi Documentation

Align mode

In this mode, uploading target files containing translations is followed by an alignment. This mode is used only in some specific cases.

Important

After each operation, the Rigi CLI tool returns a return code. The return code 0 indicates a successful operation. Any other return code signifies an error.

Use case:

Developers have implemented a new feature and uploaded the new source files to Rigi. The new strings have the Untranslated status in all target languages. The developers now pre-translate (using machine translations) newly added strings in their environment and use Rigi to review them. In this case, the Align mode allows them to upload target files containing machine-translated strings and align the untranslated strings in Rigi with translations from the machine-translated files.

Parameters:

  • -url

    • Description: The URL of the project on the Rigi server.

    • Type: String.

    • Example: -url https://xyz.rigi.io/projects/123.

  • -token

    Important

    This is the recommended authentication method.

    If this parameter is present, both -username and -password will be ignored.

    Important

    Access tokens for the Rigi CLI tool must have the following authorizations:

    1. Update project settings.

    2. Upload to workspace.

    3. Download from workspace.

    4. Tokenize strings.

    5. Upload translations.

    6. Download translations.

    7. Translate in context.

    Access_tokens.png

    For more details, see the Project settings – Access tokens section.

    This parameter has two options:

    • (Recommended) The file containing the access token for authentication (-token-file).

      • Example: -token token.txt.

      • Required: No.

    • The access token for authentication.

      • Example: -token your-access-token.

      • Required: No.

  • -username

    • Description: The username for authentication. It will be ignored if the -token parameter is provided or the environment variable RIGICICD_USERNAME is defined.

    • Example: -username jdoe@xyz.com.

    • Required: No.

  • -password

    • Description: The password for authentication. It will be ignored if the -token parameter is provided or the environment variable RIGICICD_PASSWORD is defined.

    • Example: -password "Mygreatsecret%%".

    • Required: No.

  • -repo

    • Description: The path to the repository (local working directory).

      The path can be absolute or relative to the location where the tool is executed.

    • Example: -repo .\src.

    • Required: Yes.

  • -targetfiles

    • Description: The path to the text file in which each line contains a file path to the file that must be uploaded to the workspace. The file path can be a relative file path with respect to this file or an absolute path. The files will be added to the workspace but not assigned a file ID.

    • Type: String.

    • Example: -targetfiles targets.txt

  • workspace

    If you have multiple development teams working on different modules of an application, we recommend creating separate subfolders in the Rigi workspace for each module. This strategy is particularly beneficial when the teams have different localization resource files or follow different release cycles.

    By using the -workspace parameter, you can target the specific subfolder where a team is working, ensuring that only the files in that folder are affected by the Rigi CLI tool.

    • Description: Specifies the workspace subfolder where the files should be uploaded. If no folder is specified, the files will be uploaded to the root directory.

    • Type: Directory path.

    • Example: -workspace "module1".

  • -locales

    • Description: A comma-separated list of locales (e.g., de-DE, nl-NL) for which an alignment must be performed. If this parameter is omitted, all locales will be aligned.

    • Type: Comma-separated list.

    • Example: -locales de-DE,ja-JP.

  • -cleanup

    • Description: Removes all unassigned files from the workspace before adding the new files that are uploaded with this call.

    • Type: Flag.

    • Example: -cleanup.

    • Default: False.

  • -alignstate

    • Description: The state that will be assigned to the target strings after the alignment.

    • Possible values (case-insensitive): Untranslated, Translated, Reviewed, Validated.

    • Example: -alignstate Translated.

    • Default: Translated.

  • -replacestates

    • Description: Strings that match one of the listed states will be overwritten during the alignment.

    • Type: Comma-separated list of states.

    • Possible values (case-insensitive): Untranslated, Translated, Reviewed, Validated.

    • Example: -replacestates Untranslated,Translated.

    • Default: Untranslated.

  • -tempfolder

    • Description: The path to the temporary folder used to store the align.zip file before uploading it to the server. If not specified, the app will create a temporary folder, and the -tempkeep parameter will always be false.

      The generated temporary folder will have the following name: rigi_{tenantname_rigi_io}_{projectid}.

    • Example: -tempfolder .\temp.

    • Required: No.

    • Default: A temporary folder created by the app.

  • -tempkeep

    • Description: Indicates whether to keep the content in the temporary folder -tempfolder after the operation is complete. Can be used for debugging purposes.

    • Required: No.

    • Default: If -tempfolder is not provided, the value is false.

  • -timeout <seconds>

    • Description: Checks whether the server is busy before starting the upload for the specified time.

    • Required: No.

    • Default: 120 seconds.

In this section: