Weblate Client

Neu in Version 2.7: There has been full wlc utility support ever since Weblate 2.7. If you are using an older version some incompatibilities with the API might occur.


The Weblate Client is shipped separately and includes the Python module. To use the commands below, you need to install wlc:

pip install wlc

Docker usage

The Weblate Client is also available as a Docker image.

The image is published on Docker Hub: https://hub.docker.com/r/weblate/wlc


docker pull weblate/wlc

Der Docker-Container verwendet die Standardeinstellungen von Weblate und verbindet sich mit der auf localhost bereitgestellten API. Die API-URL und der API_KEY können über die von Weblate akzeptierten Argumente konfiguriert werden.

The command to launch the container uses the following syntax:

docker run --rm weblate/wlc [WLC_ARGS]


docker run --rm weblate/wlc --url https://hosted.weblate.org/api/ list-projects

You might want to pass your Konfigurationsdateien to the Docker container, the easiest approach is to add your current directory as /home/weblate volume:

docker run --volume $PWD:/home/weblate --rm weblate/wlc show

Getting started

The wlc configuration is stored in ~/.config/weblate (see Konfigurationsdateien for other locations), please create it to match your environment:

url = https://hosted.weblate.org/api/

https://hosted.weblate.org/api/ = APIKEY

You can then invoke commands on the default server:

wlc ls
wlc commit sandbox/hello-world


wlc [arguments] <command> [options]

Commands actually indicate which operation should be performed.


Weblate Client is a Python library and command-line utility to manage Weblate remotely using Weblate’s REST API. The command-line utility can be invoked as wlc and is built-in on wlc.


Das Programm akzeptiert die folgenden Argumente, die das Ausgabeformat oder die zu verwendende Weblate-Instanz definieren. Diese müssen vor jedem Befehl eingegeben werden.

--format {csv,json,text,html}

Specify the output format.

--url URL

Specify the API URL. Overrides any value found in the configuration file, see Konfigurationsdateien. The URL should end with /api/, for example https://hosted.weblate.org/api/.

--key KEY

Specify the API user key to use. Overrides any value found in the configuration file, see Konfigurationsdateien. You can find your key in your profile on Weblate.

--config PATH

Overrides the configuration file path, see Konfigurationsdateien.

--config-section SECTION

Overrides configuration file section in use, see Konfigurationsdateien.


The following commands are available:


Prints the current version.


Lists used languages in Weblate.


Lists projects in Weblate.


Lists components in Weblate.


Lists translations in Weblate.


Shows Weblate object (translation, component or project).


Lists Weblate object (translation, component or project).


Commits changes made in a Weblate object (translation, component or project).


Pulls remote repository changes into Weblate object (translation, component or project).


Pushes Weblate object changes into remote repository (translation, component or project).


Neu in Version 0.7: Supported since wlc 0.7.

Resets changes in Weblate object to match remote repository (translation, component or project).


Neu in Version 0.9: Supported since wlc 0.9.

Removes any untracked changes in a Weblate object to match the remote repository (translation, component or project).


Displays repository status for a given Weblate object (translation, component or project).


Displays detailed statistics for a given Weblate object (translation, component or project).


Neu in Version 0.5: Supported since wlc 0.5.

Displays lock status.


Neu in Version 0.5: Supported since wlc 0.5.

Locks component from further translation in Weblate.


Neu in Version 0.5: Supported since wlc 0.5.

Unlocks translation of Weblate component.


Neu in Version 0.7: Supported since wlc 0.7 and Weblate 2.10.

Displays changes for a given object.


Neu in Version 0.7: Supported since wlc 0.7.

Downloads a translation file.


Converts file format, if unspecified no conversion happens on the server and the file is downloaded as is to the repository.


Specifies file to save output in, if left unspecified it is printed to stdout.


Neu in Version 0.9: Supported since wlc 0.9.

Uploads a translation file.


Beim Hochladen vorhandene Übersetzungen überschreiben.


File from which content is read, if left unspecified it is read from stdin.


Upload method to use, see Import methods.


Fuzzy (marked for edit) strings processing (empty, process, approve)


Author name, to override currently authenticated user


Author e-mail, to override currently authenticated user


You can get more detailed information on invoking individual commands by passing --help, for example: wlc ls --help.


:Datei:`.weblate`, :Datei:`.weblate.ini`, :Datei:`weblate.ini`

Geändert in Version 1.6: Die Dateien mit der Erweiterung .ini werden ebenfalls akzeptiert.

Pro Projekt-Konfigurationsdatei


Neu in Version 1.6.

Benutzer-Konfigurationsdatei unter Windows.




Systemweite Konfigurationsdatei

The program follows the XDG specification, so you can adjust placement of config files by environment variables XDG_CONFIG_HOME or XDG_CONFIG_DIRS. On Windows APPDATA directory is preferred location for the configuration file.

Following settings can be configured in the [weblate] section (you can customize this by --config-section):


API-SCHLÜSSEL für den Zugriff auf Weblate.


API server URL, defaults to


Pfad zur Standardübersetzung - Komponente oder Projekt.

Die Konfigurationsdatei ist eine INI-Datei, zum Beispiel:

url = https://hosted.weblate.org/api/
key = APIKEY
translation = weblate/application

Zusätzlich können API-Schlüssel im Abschnitt [keys] gespeichert werden:

https://hosted.weblate.org/api/ = APIKEY

This allows you to store keys in your personal settings, while using the .weblate configuration in the VCS repository so that wlc knows which server it should talk to.


Aktuelle Programmversion drucken:

$ wlc version
version: 0.1

Alle Projekte auflisten:

$ wlc list-projects
name: Hello
slug: hello
url: http://example.com/api/projects/hello/
web: https://weblate.org/
web_url: http://example.com/projects/hello/

Übersetzungsdatei hochladen:

$ wlc upload project/component/language --input /tmp/hello.po

Sie können auch angeben, an welchem Projekt wlc arbeiten soll:

$ cat .weblate
url = https://hosted.weblate.org/api/
translation = weblate/application

$ wlc show
branch: main
file_format: po
source_language: en
filemask: weblate/locale/*/LC_MESSAGES/django.po
git_export: https://hosted.weblate.org/git/weblate/application/
license: GPL-3.0+
license_url: https://spdx.org/licenses/GPL-3.0+
name: Application
new_base: weblate/locale/django.pot
project: weblate
repo: git://github.com/WeblateOrg/weblate.git
slug: application
url: https://hosted.weblate.org/api/components/weblate/application/
vcs: git
web_url: https://hosted.weblate.org/projects/weblate/application/

Mit diesem Setup können anstehende Änderungen im aktuellen Projekt einfach übertragen werden:

$ wlc commit