Skip to main content

Rigi Documentation

Download mode

The download mode tool facilitates downloading target files from a specified Rigi server.

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.

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.

    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.

  • -locales

    • Description: A comma-separated list of locale values that specify the languages or regions for which target files must be downloaded. If not defined, the target files for all locales will be downloaded unless -nolocales is set.

    • Type: Comma-separated list.

    • Example: -locales en,fr,de.

  • -nolocales

    • Description: When specified, no target languages will be downloaded. This parameter overrides the -locales parameter.

    • Type: Flag.

    • Example: -nolocales.

  • -master

    • Description: Includes the (mastered) source files in the download.

    • Type: Flag.

    • Example: -master.

  • -master-locale

    • Description: Downloads the master language as the target language.

    • Type: Flag.

    • Example: -master-locale.

  • -pseudo

    • Description: Downloads files containing Rigi tokens that can be used for simulation or testing scenarios.

    • Type: Flag.

    • Example: -pseudo.

  • -targetfolder

    • Description: Specifies the folder in which the downloaded ZIP files will be extracted.

    • Type: Directory path.

    • Example: -targetfolder /path/to/target.

  • -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 with source files, from which the files should be generated. If no folder is specified, the files will be generated for all source files in the workspace.

    • Type: Directory path.

    • Example: -workspace "module1".

  • -writestates

    • Description: A comma-separated list of states. Supported parsers will only write strings with the listed states.

      By default, all strings are written to the target resource files.

    • Type: Comma-separated list.

    • Possible values (case-insensitive): untranslated, translated, reviewed, validated.

    • Example: -writestates translated,reviewed,validated. This will write all strings except those with the status untranslated.

  • -mt

    • Description: When specified, applies machine translation to untranslated strings before downloading. The applied MT engine will be selected according to the project's MT Profile (for details, see Project settings – Translation).

    • Type: Flag.

    • Required: No.

    • Example: -mt.

Usage

To download the latest state of translation files, utilize the command structure in the following manner:

dotnet Rigi-CLI.dll download -url https://xyz.rigi.io/projects/123 -targetfolder C:\repos\repo -locales de-DE,pl-PL -username jdoe@xyz.com -password "xxxxxxxx" -master -pseudo

In this section: