Weblate Client

Installation

The Weblate Client is shipped separately and includes the Python module. The source code is maintained in the WeblateOrg/wlc repository. To use the commands below, you need to install wlc using pip:

pip install wlc

També podeu executar-lo directament mitjançant uvx:

uvx wlc --help

Suggeriment

També podeu utilitzar aquest wlc com a mòdul de Python, vegeu wlc.

Docker usage

El client Weblate també està disponible com a imatge de Docker.

Images are published on Docker Hub and the GitHub Container Registry. The examples below use the Docker Hub image name.

Installing:

docker pull weblate/wlc

The following tags are available:

latest

Latest stable release.

Full version, for example 2.2.0

A specific stable release.

Major version, for example 2

Latest stable release in that major series.

edge

Current development version from the main branch.

edge-YYYY-MM-DD-COMMIT

A specific development snapshot.

To build an image from the source checkout:

docker build -t weblate/wlc .

The Docker container uses Weblate Client defaults and connects to the API deployed on localhost. Configure the API URL and API key using the normal wlc arguments or environment variables, for example --url, --key, WLC_URL, and WLC_KEY. API keys are rejected over non-local http:// URLs by default; use HTTPS, loopback HTTP for local development, or explicitly opt in to insecure HTTP.

L’ordre per llançar el contenidor utilitza la sintaxi següent:

docker run --rm weblate/wlc [WLC_ARGS]

Exemple:

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

És possible que vulgueu passar el vostre Fitxers de configuració al contenidor de Docker. Quan el vostre dipòsit conté una configuració de projecte com ara .weblate, l’enfocament més fàcil és afegir el vostre directori actual com el volum /home/weblate:

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

When the mounted repository provides the API URL in project configuration and you pass an unscoped API key to the container, also pin the URL explicitly: WLC_KEY requires WLC_URL, and --key requires --url. The same pairing is required for the --allow-insecure-http and --allow-insecure-ssl overrides.

If the configured API URL uses non-local http:// and an API key is provided, the container refuses to send the key unless insecure HTTP is explicitly enabled. Prefer HTTPS; for legacy deployments, pass --allow-insecure-http or set WLC_ALLOW_INSECURE_HTTP. TLS certificates are always verified by default, including for loopback URLs. Use --allow-insecure-ssl or WLC_ALLOW_INSECURE_SSL only when certificate verification can not be enabled.

Per començar

La manera més senzilla de començar és crear una configuració personal wlc a ~/.config/weblate (vegeu Fitxers de configuració per a les regles completes de descobriment i altres ubicacions):

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

[keys]
https://hosted.weblate.org/api/ = APIKEY

A continuació, podeu invocar ordres al servidor predeterminat:

wlc ls
wlc commit sandbox/hello-world

Vegeu també

Fitxers de configuració

Legacy configuration

Canviat a la versió 1.17: The legacy configuration using unscoped key is no longer supported.

Canviat a la versió 2.2.0: Global allow_insecure_http configuration is no longer supported. Configure an origin in the [insecure_http] section instead.

Migrate legacy configuration:

[weblate]
url = https://hosted.weblate.org/api/
key = YOUR_KEY_HERE

Per a una configuració amb l’àmbit de la clau a l’URL d’una API:

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

[keys]
https://hosted.weblate.org/api/ = YOUR_KEY_HERE

Synopsis

wlc [arguments] <command> [options]

Les ordres indiquen realment quina operació s’ha de realitzar.

Descripció

Weblate Client is a Python library and command-line utility to manage Weblate remotely using API REST del Weblate. Invoke the command-line utility as wlc; see wlc for the Python API.

Arguments

El programa accepta els arguments següents que defineixen el format de sortida o quina instància de Weblate utilitzar. S’han d’introduir abans de qualsevol comanda.

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

Specify the output format. The default is text.

--version

Print the program version and exit. The version command supports output formatting and can print only the version number.

--debug

Print verbose HTTP communication. Authorization header values are redacted and request bodies are not logged, but query parameters are; do not put secrets in query parameters.

--url URL

Especifiqueu l’URL de l’API. Substitueix qualsevol valor que es trobi al fitxer de configuració, vegeu Fitxers de configuració. L’URL hauria d’acabar amb /api/, per exemple https://hosted.weblate.org/api/.

--key KEY

Specify the API user key to use. Overrides any value found in the configuration file, see Fitxers de configuració. You can find your key in your profile on Weblate. When the API URL is loaded from automatically discovered project configuration, --key must be used together with --url. API keys are rejected over non-local http:// URLs by default.

--allow-insecure-http

Allow sending API keys over non-local http:// URLs. Prefer HTTPS or loopback HTTP instead; this option is intended only for legacy deployments where HTTPS is not available. This option only enables insecure HTTP for the current run. When the API URL comes from automatically discovered project configuration, this option requires --url.

--allow-insecure-ssl

Disable TLS certificate verification for the current run. Certificates are verified by default for every HTTPS URL, including loopback URLs. When the API URL comes from automatically discovered project configuration, this option requires --url.

--config PATH

Carregueu la configuració només des de PATH en comptes dels fitxers de configuració global i del projecte descoberts, vegeu Fitxers de configuració.

--config-section SECTION

Selects the configuration file section to use instead of [weblate], see Fitxers de configuració.

Object paths

Commands that operate on an object accept one of these paths:

PROJECT

Project slug.

PROJECT/COMPONENT

Component slug, including its project.

PROJECT/COMPONENT/LANGUAGE

Translation language, including its project and component.

UNIT_ID

Numeric translation unit ID. Only commands that explicitly support units accept this form.

Commands that require an object use the translation setting from Fitxers de configuració when the path is omitted. The ls and download commands also use this setting before falling back to their no-object behavior. For list-components and list-translations, an omitted object always requests an instance-wide list.

Commands

Les ordres següents estan disponibles:

version

Imprimeix la versió actual.

--bare

Prints only the version number.

list-languages

Lists all languages in Weblate.

list-projects

Lists all projects in Weblate.

list-components

Lists all components in Weblate, or components in the specified project.

list-translations

Lists all translations in Weblate, or translations in the specified component.

list-units

Lists units in the specified translation.

--query QUERY

Filters units using the search query syntax.

show

Shows a project, component, translation, or unit.

delete

Deletes a project, component, translation, or unit without a confirmation prompt.

ls

Lists all projects when no object is specified, components in a project, or translations in a component.

commit

Admet els canvis fets en un objecte Weblate (traducció, component o projecte).

pull

Introdueix els canvis del repositori remot a l’objecte Weblate (traducció, component o projecte).

push

Envia els canvis d’objecte de Weblate al repositori remot (traducció, component o projecte).

reset

Restableix els canvis a l’objecte Weblate perquè coincideixin amb el dipòsit remot (traducció, component o projecte).

cleanup

Elimina qualsevol canvi sense seguiment en un objecte Weblate perquè coincideixi amb el dipòsit remot (traducció, component o projecte).

repo

Mostra l’estat del repositori d’un objecte Weblate determinat (traducció, component o projecte).

stats

Mostra estadístiques detallades d’un objecte Weblate determinat (traducció, component o projecte).

lock-status

Displays the lock status of a component.

lock

Bloqueja el component de la traducció posterior a Weblate.

unlock

Desbloqueja la traducció del component Weblate.

changes

Displays changes for a project, component, or translation.

download

Downloads translation files. For a translation, wlc writes the file to --output or to redirected standard output. It refuses to write raw file content to an interactive terminal.

For a component or project, --output is required and is treated as a directory. wlc writes one ZIP archive per component. With no object, it downloads every component in the Weblate instance in the same way.

--convert FORMAT

Requests conversion to FORMAT on the server. If unspecified, no conversion happens.

--output PATH

Specifies the output file for a translation or output directory for a component, project, or instance-wide download. Use - to write a translation to standard output.

--no-glossary

Excludes glossary components from component, project, and instance-wide downloads.

upload

Carrega un fitxer de traducció.

--overwrite

Overwrites existing translated strings. This is equivalent to --conflicts replace-translated.

--conflicts {ignore,replace-translated,replace-approved}

Selects how conflicts with existing translations are handled.

--input PATH

Reads content from PATH. If unspecified or -, content is read from standard input.

--method {translate,approve,suggest,fuzzy,replace,source,add}

Upload method to use, see Mètodes d’importació. The default is translate.

--fuzzy {process,approve}

Selects processing of fuzzy strings (marked for edit).

--author-name NAME

Nom de l’autor, per substituir l’usuari autenticat actualment

--author-email EMAIL

Correu electrònic de l’autor, per anul·lar l’usuari autenticat actualment

edit-unit

Updates a translation unit. At least one update option is required.

--target TARGET [TARGET ...]

Sets one or more translated strings.

--state STATE

Sets the unit state: 0 for empty, 10 for fuzzy, 20 for translated, or 30 for approved.

--explanation EXPLANATION

Sets the string explanation.

--extra-flags FLAGS

Sets additional string flags.

Suggeriment

Podeu obtenir informació més detallada sobre com invocar ordres individuals passant --help, per exemple: wlc ls --help.

Fitxers de configuració

Quan es proporciona --config, wlc només carrega aquest fitxer.

Sense --config, wlc carrega primer el fitxer de configuració global descobert des de les ubicacions estàndard específiques de la plataforma:

C:\Users\NAME\AppData\Roaming\weblate.ini

Fitxer de configuració global a Windows al perfil itinerant.

C:\Users\NAME\AppData\Local\weblate.ini

Fitxer de configuració global a Windows al perfil local.

~/.config/weblate

Fitxer de configuració global en sistemes semblants a Unix.

~/.config/weblate.ini

Alternative global configuration filename on Unix-like systems.

/etc/xdg/weblate

System-wide fallback configuration file.

/etc/xdg/weblate.ini

Alternative system-wide fallback filename.

El programa segueix l’especificació XDG, de manera que podeu ajustar la ubicació dels fitxers de configuració per variables d’entorn XDG_CONFIG_HOME o XDG_CONFIG_DIRS.

A Windows, els directoris APPDATA i LOCALAPPDATA són les ubicacions preferides per al fitxer de configuració.

Després de carregar la configuració global, wlc carrega el fitxer de configuració del projecte més proper des del directori actual o dels seus pares:

.weblate, .weblate.ini, weblate.ini

Project configuration file placed in the repository.

Project configuration is loaded after global configuration and overrides matching settings. It can select the API URL, default object, request settings, and a matching URL-scoped API key, allowing a cloned repository to automatically select its Weblate server and translation.

Només es carrega el fitxer de configuració del projecte més proper. Els fitxers de configuració dels directoris principals més llunyans s’ignoren.

Els paràmetres següents es poden configurar a la secció [weblate] (pot personalitzar-ho mitjançant --config-section):

key

S’ha eliminat a la versió 1.17: Utilitzeu la secció [keys] per especificar l’àmbit de les claus per a URL d’API individuals, vegeu Legacy configuration.

url

URL del servidor de l’API, el valor predeterminat és http://127.0.0.1:8000/api/.

translation

Default object path for commands that accept one: a project, component, translation, or numeric unit ID.

retries, timeout, allowed_methods, backoff_factor, status_forcelist

HTTP request retry and timeout settings. retries defaults to 0 and backoff_factor to 0. status_forcelist is a comma-separated list of HTTP status codes that trigger retries and is empty by default.

allowed_methods lists methods that may be retried, separated by commas or whitespace. It defaults to HEAD, DELETE, OPTIONS, PUT, and GET. These retry settings are passed to urllib3.util.Retry.

timeout is the request timeout in seconds and defaults to 300. Current wlc releases use allowed_methods in place of the older method_whitelist option.

El fitxer de configuració és un fitxer INI, per exemple:

[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/application
retries = 3
allowed_methods = PUT,POST,GET
backoff_factor = 0.2
status_forcelist = 429,500,502,503,504
timeout = 30

Les claus de l’API s’emmagatzemen a la secció [keys]:

[keys]
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. The [keys] lookup is scoped to the complete configured API URL, not merely its network origin.

Project configuration can also supply or replace a matching entry in [keys]. Do not commit valuable API keys to version control; normally keep keys in personal configuration and only the API URL and default object in project configuration.

Insecure transport exceptions are stored in origin-scoped sections in trusted user configuration:

[insecure_http]
http://legacy.example.com:80 = true

[insecure_ssl]
https://legacy.example.com:443 = true

An origin consists of the scheme, normalized hostname, and effective port. The API path is ignored, while different schemes and ports remain isolated. The [insecure_http] section allows API keys over non-local HTTP for matching origins. The [insecure_ssl] section disables TLS certificate verification for matching origins.

Canviat a la versió 2.2.0: TLS certificates are verified for all hosts by default. Insecure HTTP and TLS configuration is scoped to origins. Automatically discovered project configuration can neither add entries to these sections nor enable the removed global settings. User configuration and explicitly selected --config files are trusted.

In CI, unscoped keys must pin the API URL explicitly: set both WLC_URL and WLC_KEY, or use --url together with --key.

Environment variables

Afegit a la versió 1.18.0.

Canviat a la versió 2.0.1: Unscoped API keys require an explicit API URL when project configuration is discovered automatically. API keys are rejected over non-local http:// URLs unless insecure HTTP is explicitly enabled.

Canviat a la versió 2.2.0: Insecure HTTP and TLS environment overrides require WLC_URL when the API URL would otherwise come from automatically discovered project configuration.

The API URL and key can also be configured using environment variables. This is especially useful for CI workflows where WLC_URL pins the destination and WLC_KEY is injected as a secret:

WLC_URL

URL de l’API

WLC_KEY

API key. When the API URL would otherwise come from automatically discovered project configuration, WLC_KEY is accepted only together with WLC_URL. API keys are rejected over non-local http:// URLs by default.

WLC_ALLOW_INSECURE_HTTP

Set to 1, true, yes, or on to allow API keys over non-local http:// URLs. Prefer HTTPS or loopback HTTP instead. Other values, such as 0 or false, are treated as unset. When the API URL would otherwise come from automatically discovered project configuration, this variable is accepted only together with WLC_URL.

WLC_ALLOW_INSECURE_SSL

Set to 1, true, yes, or on to disable TLS certificate verification. Other values, such as 0 or false, are treated as unset. When the API URL would otherwise come from automatically discovered project configuration, this variable is accepted only together with WLC_URL.

The same protection applies to command-line arguments: --key, --allow-insecure-http, and --allow-insecure-ssl are accepted with automatically discovered project configuration only when --url is provided.

The API URL and key configuration precedence (highest to lowest) is:

1. Arguments de la línia d’ordres (--url, --key).

2. Variables d’entorn (WLC_URL, WLC_KEY).

3. Configuració carregada des de --config, o des de la configuració global descoberta més la configuració del projecte més propera quan no s’utilitza --config.

The insecure transport opt-ins are enable-only rather than normal precedence settings. They are enabled by a command-line or environment override, or by a matching origin in the trusted [insecure_http] or [insecure_ssl] section. Automatically discovered project configuration cannot add trusted origins.

Security model

Project configuration is part of the repository workflow and is intentionally trusted to select the API endpoint, default object, request settings, and a matching URL-scoped API key. Running wlc inside a repository authorizes its nearest project configuration to select the server that receives commands and uploads and supplies displayed or downloaded content. Use an explicit trusted --config file when this is not desired.

The command-line client accepts API keys from --key, WLC_KEY, or the [keys] section. It does not load HTTP authentication from .netrc or the file named by NETRC. Credentials embedded in API URLs are rejected; use an API key instead. Other Requests environment integration, including proxy and CA-bundle variables, remains enabled.

The wlc threat model documents the complete trust boundaries, security properties, non-goals, and downstream responsibilities. A version-matched copy is included in source and wheel distributions. Report security issues using the Weblate vulnerability reporting process.

Examples

Imprimeix la versió actual del programa:

$ wlc version

Llista tots els projectes:

$ 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/

Upload translation file:

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

També podeu designar en quin projecte wlc hauria de funcionar:

$ cat .weblate
[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
template:
url: https://hosted.weblate.org/api/components/weblate/application/
vcs: git
web_url: https://hosted.weblate.org/projects/weblate/application/

Amb aquesta configuració és fàcil confirmar canvis pendents en el projecte actual:

$ wlc commit