translate_strings

A tool for Xcode to automatically add language translations to your Strings Catalog file using DeepL, Anthropic Claude or OpenAI GPT services.

Getting Started

To translate all strings in your app to Japanese using default DeepL for translation, call:

strings_catalog_translate -k [API_KEY] -t ja

Ensure that the initial Strings Catalog file is added to your Xcode project. More details can be found here.

By default the command will read the Localizable.xcstrings from the path where it was run and modify it with the translations.

Usage

OVERVIEW: A utility for language translation of Xcode Strings Catalogs.

USAGE: strings_catalog_translate <subcommand>

OPTIONS:
  --version               Show the version.
  -h, --help              Show help information.

SUBCOMMANDS:
  deepl                   Translate Xcode Strings Catalog using DeepL service.
  openai                  Translate Xcode Strings Catalog using OpenAI service.
  gemini                  Translate Xcode Strings Catalog using Gemini service.
  anthropic               Translate Xcode Strings Catalog using Anthropic service.
  list_keys               List API keys stored in Keychain.
  delete_key              Delete an API keys stored in Keychain.
  print_key               Print an API key stored in Keychain to STDOUT.

  See 'strings_catalog_translate help <subcommand>' for detailed help.

The subcommands have mostly the same arguments, with a few platform specific variations.

% ./.build/release/strings_catalog_translate gemini -h

OVERVIEW: Translate Xcode Strings Catalog using Gemini service.

USAGE: strings_catalog_translate gemini [--verbose] [--key <key>] [--available_languages] [--input-file <input-file>] [--output-file <output-file>] [--target-language <target-language>] [--model <model>] [--project-id <project-id>]

OPTIONS:
  -v, --verbose           Enable verbose output to STDOUT.
  -k, --key <key>         --key <key> 
                          1. **From Keychain**:
                              - Format: `key_id:[YOUR_KEY_ID]` (e.g., `key_id:key1`)
                              - The tool will search for `YOUR_KEY_ID` in the keychain.
                              - If not found, you will be prompted to enter the key.
                              - The entered key will be securely saved under `YOUR_KEY_ID` for future use.
                          2. **From Environment Variable**:
                              - Set a standard environment variable like `OPENAI_API_KEY`.
                              - Or specify a custom variable using the format `env:MY_API_KEY`.
                          3. **Direct Value**:
                              - Provide the API key as a plain string (e.g., `--key your-api-key`).
  --available_languages   List all available translation language codes supported by the service.
  -i, --input-file <input-file>
                          Path to the input Strings Catalog file. (default: Localizable.xcstrings)
  -o, --output-file <output-file>
                          Path to the output Strings Catalog file.
                              - This file will be overwritten if it exists.
                              - Use `-` to output to STDOUT. (default: Localizable.xcstrings)
  -t, --target-language <target-language>
                          Target language identifier (e.g., `de` for German). Case-insensitive.
  --model <model>         Specify the model to use. (default: gemini-1.5-flash)
  --project-id <project-id>
                          Specify a Project ID
  --version               Show the version.
  -h, --help              Show help information.

Notes:

1. Only untranslated strings will be processed. Those already translated or marked "do not translate" in the Strings Catalog are skipped.
2. By default the Localizable.xcstrings file will be modified.

API Keys

• DeepL: Get a key from the DeepL Pro API.
• Gemini Make a project and generate an API Key in Google AI Studio.
• OpenAI: Obtain a key from their API portal.
• Anthropic Get a key from Anthropic Dashboard.

Saved API keys in the keychain can be managed using the macOS Keychain app and searching keys prefixed with tools.xcode.translate_strings.

---

Building

1. Run swift build -c release to build the translate_strings executable in ./.build/release.
2. Copy the executable to a location in your $PATH for easy access.

Package Targets

The package has two targets:

1. strings_catalog_translate the executable command line tool.
2. TranslationService the library the executiable uses for for the translation services. It specifies the protocol and concrete types for DeepL, Anthropic and OpenAI.