DOCSEARCHbyAlgolia
Submit Docs

Tolgee Documentation

website·Indexed 36 days ago

https://docs.tolgee.io

Documentation for Tolgee, an open-source localization platform. Includes guides for self-hosting version 3.x.x via Docker, YAML, or environment variables, the Tolgee CLI for translation extraction, and the JS SDK (versions 4.x.x through 7.x.x) with integrations for React, Svelte, and i18next.

Tokens
258.3K
Snippets
1.6K
Records
2.2K
Agent score
67%

What's inside Tolgee

  1. Overview of the Tolgee MCP server

    The Tolgee MCP server is a Model Context Protocol (MCP) endpoint that allows AI coding assistants (such as Claude Desktop, Claude Code, Cursor, Windsurf, and ChatGPT) to manage localization projects using natural language. It enables developers to handle translations, keys, and languages directly from their editor without switching contexts.

    For Tolgee Cloud, the server is hosted at https://app.tolgee.io/mcp/developer. It is also available on all self-hosted Tolgee instances. The server is listed in the MCP Registry as io.github.tolgee/tolgee.

  2. Overview of Tolgee's Slack Integration

    Tolgee's Slack integration connects localization projects to a Slack workspace. It allows teams to subscribe to project updates and receive real-time notifications regarding new keys, translations, and other project activities directly within Slack channels to improve collaboration and visibility.

  3. Overview of Machine Translation in Tolgee

    Machine translation (MT) allows users to speed up the translation process by using external services to generate rough translations of content. This feature is available on both Tolgee Cloud and self-hosted instances. For self-hosted instances, users can either purchase a plan for pre-configured providers or provide their own API keys via the configuration settings.

  4. Overview of the Tolgee Localization Platform

    Tolgee is a developer-friendly localization platform designed for web, mobile, and desktop applications. It streamlines the translation workflow by enabling in-context translation and string management without requiring manual file management or constant code changes.

  5. Overview of Tolgee CLI capabilities

    The Tolgee CLI is a command-line utility designed to synchronize a code project with a translation project on the Tolgee platform. Key capabilities include:

    • Automating the download and upload of localization files.
    • Scanning source code to automatically extract localization strings and sync them with the project.
    • Support for both Tolgee's cloud service and self-hosted Tolgee servers.

  6. Overview of the Tolgee localization workflow

    Tolgee decouples developers from the localization process. After the initial development and integration of Tolgee libraries, developers are no longer required to manually manage localization strings. Translators can modify texts directly within the Tolgee Platform or in-context within the product, and changes are synchronized automatically.

  7. Overview of methods to add translation keys to Tolgee

    Translation keys identify strings displayed to users and are used in both translation files and source code. There are several ways to add them to a Tolgee project:

    • Manual Creation: Use the Tolgee platform editor to create a single key.
    • Import: Import a translation file containing keys.
    • API: Use the Tolgee API create endpoint to add one or more keys.
    • CLI: Use the push command via the Tolgee CLI.
    • Figma Plugin: Use the Upload action within the Tolgee Figma plugin.
    Example of a translation key:
settings.account-security.mfa.disable-mfa

  8. Overview of Tolgee iOS and macOS SDK capabilities

    The Tolgee iOS and macOS SDK allows developers to deliver translation updates directly to applications via Over-the-Air (OTA) updates, eliminating the need for new App Store releases for copy changes. Key features include:

    • OTA Updates: Deliver translations via Tolgee Cloud CDN or a self-hosted CDN with caching.
    • Framework Support: Compatible with both UIKit and SwiftUI, including hooks for reactive translation updates.
    • Resilience: Works offline using caching and resource fallbacks to bundled translations to prevent blank strings.
    • Runtime Language Control: Ability to change the app language at runtime independently of the system language.
    • Flexible Architecture: Supports translations split across multiple files or stored in separate frameworks/packages.

  9. Overview of Tolgee native integrations

    Tolgee native integrations allow users to edit translations directly within an application without developer intervention, create one-click screenshots to provide translators with visual context, and improve machine translation quality by gathering application context.

  10. Overview of Tolgee CLI capabilities

    The Tolgee CLI (v2.x.x) is a command-line utility designed to synchronize a local code project with a Tolgee translation project. Key capabilities include:

    • Project Configuration: Use a .tolgeerc file to store project-specific options and avoid repetitive CLI flags.
    • String Synchronization: Push new or updated strings to Tolgee and pull translation files during production builds.
    • Automated Extraction: Scan source code to automatically extract localization strings and sync them with the project.
    • Key Tagging: Mark keys (e.g., production, deprecated, drafts) to track string usage across different environments and branches.
    • Self-Hosted Support: Compatible with both the Tolgee SaaS and self-hosted Tolgee server installations.

  11. Overview of Tolgee Android SDK capabilities

    The Tolgee Android SDK provides dynamic content delivery and Over-the-Air (OTA) translation updates for Android applications. It allows developers to ship translation fixes and new languages without requiring a new app build or release. Key features include:

    • OTA Updates: Deliver translations via Tolgee Cloud CDN or a self-hosted CDN with caching.
    • UI Framework Support: Seamless integration with both traditional Android Views and Jetpack Compose.
    • Reactive Locale Changes: UI updates reactively when the locale changes via the Tolgee.changeFlow API.
    • Resilience: Supports offline mode through caching and falls back to standard Android resources to prevent blank strings.
    • Performance: Ability to preload critical namespaces and locales.

  12. Overview of Tolgee Localization Platform

    Tolgee is a developer-focused Translation Management System (TMS) designed for internationalization (i18n) of web, mobile, and desktop applications. It allows translation of applications without modifying source code, eliminating the need to manually edit localization files or export data for translators.