Klient Weblate

Inštalácia

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

Môžete ho tiež spustiť priamo pomocou uvx:

uvx wlc --help

Rada

Tento wlc môžete tiež použiť ako Python modul, pozri wlc.

Použitie Docker

Klient Weblate je tiež dostupný ako Docker obraz.

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

Inštalácia:

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 .

Docker kontajner používa predvolené nastavenia klienta Weblate a pripája sa k API nasadenému na localhoste. Nakonfigurujte URL API a kľúč API pomocou bežných argumentov wlc alebo premenných prostredia, napríklad --url, --key, WLC_URL a WLC_KEY. Kľúče API sú predvolene odmietané cez nelokálne URL http://; použite HTTPS, loopback HTTP pre lokálny vývoj alebo explicitne povoľte nezabezpečené HTTP.

Príkaz na spustenie kontajnera používa nasledujúcu syntax:

docker run --rm weblate/wlc [WLC_ARGS]

Príklad:

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

Môžete chcieť odovzdať vašu Konfiguračné súbory Docker kontajneru. Keď váš repozitár obsahuje konfiguráciu projektu, ako je .weblate, najjednoduchší prístup je pridať váš aktuálny adresár ako zväzok /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.

Začíname

Najjednoduchší spôsob, ako začať, je vytvoriť osobnú konfiguráciu wlc v ~/.config/weblate (pozri Konfiguračné súbory pre úplné pravidlá objavovania a iné umiestnenia):

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

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

Potom môžete vyvolať príkazy na predvolenom serveri:

wlc ls
wlc commit sandbox/hello-world

Viď aj

Konfiguračné súbory

Staršia konfigurácia

Zmenené vo verzii 1.17: Staršia konfigurácia používajúca neobmedzený key už nie je podporovaná.

Zmenené vo verzii 2.2.0: Global allow_insecure_http configuration is no longer supported. Configure an origin in the [insecure_http] section instead.

Migrácia starej konfigurácie:

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

Na konfiguráciu s kľúčom obmedzeným na URL API:

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

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

Prehľad

wlc [arguments] <command> [options]

Príkazy skutočne indikujú, ktorá operácia sa má vykonať.

Popis

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

Argumenty

Program akceptuje nasledujúce argumenty, ktoré definujú formát výstupu alebo ktorú inštanciu Weblate použiť. Tieto sa musia zadať pred akýmkoľvek príkazom.

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

Špecifikujte URL API. Prepíše akúkoľvek hodnotu nájdenú v konfiguračnom súbore, pozri Konfiguračné súbory. URL by mala končiť na /api/, napríklad https://hosted.weblate.org/api/.

--key KEY

Špecifikujte kľúč používateľa API, ktorý sa má použiť. Prepíše akúkoľvek hodnotu nájdenú v konfiguračnom súbore, pozri Konfiguračné súbory. Svoj kľúč nájdete vo svojom profile na Weblate. Keď sa URL API načíta z automaticky objavenej konfigurácie projektu, --key sa musí použiť spolu s --url. Kľúče API sú predvolene odmietané cez nelokálne URL http://.

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

Načítať konfiguráciu iba z PATH namiesto objavených globálnych a projektových konfiguračných súborov, pozri Konfiguračné súbory.

--config-section SECTION

Selects the configuration file section to use instead of [weblate], see Konfiguračné súbory.

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 Konfiguračné súbory 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.

Príkazy

Dostupné sú nasledujúce príkazy:

version

Vypíše aktuálnu verziu.

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

Zapíše zmeny vykonané v objekte Weblate (preklad, komponent alebo projekt).

pull

Stiahne zmeny zo vzdialeného repozitára do objektu Weblate (preklad, komponent alebo projekt).

push

Odošle zmeny objektu Weblate do vzdialeného repozitára (preklad, komponent alebo projekt).

reset

Resetuje zmeny v objekte Weblate, aby zodpovedali vzdialenému repozitáru (preklad, komponent alebo projekt).

cleanup

Odstráni všetky nesledované zmeny v objekte Weblate, aby zodpovedali vzdialenému repozitáru (preklad, komponent alebo projekt).

repo

Zobrazí stav repozitára pre daný objekt Weblate (preklad, komponent alebo projekt).

stats

Zobrazí podrobné štatistiky pre daný objekt Weblate (preklad, komponent alebo projekt).

lock-status

Displays the lock status of a component.

lock

Uzamkne komponent pred ďalším prekladom vo Weblate.

unlock

Odomkne preklad komponentu 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

Nahrá prekladový súbor.

--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 Metódy importu. The default is translate.

--fuzzy {process,approve}

Selects processing of fuzzy strings (marked for edit).

--author-name NAME

Meno autora, na prepísanie aktuálne autentifikovaného používateľa

--author-email EMAIL

E-mail autora, na prepísanie aktuálne autentifikovaného používateľa

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.

Rada

Podrobnejšie informácie o vyvolávaní jednotlivých príkazov získate zadaním --help, napríklad: wlc ls --help.

Konfiguračné súbory

Keď je poskytnutý --config, wlc načíta iba tento súbor.

Bez --config, wlc najprv načíta objavený globálny konfiguračný súbor zo štandardných umiestnení špecifických pre platformu:

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

Globálny konfiguračný súbor na Windows v roamingovom profile.

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

Globálny konfiguračný súbor na Windows v lokálnom profile.

~/.config/weblate

Globálny konfiguračný súbor na systémoch typu Unix.

~/.config/weblate.ini

Alternative global configuration filename on Unix-like systems.

/etc/xdg/weblate

Systémový záložný konfiguračný súbor.

/etc/xdg/weblate.ini

Alternative system-wide fallback filename.

Program dodržiava špecifikáciu XDG, takže umiestnenie konfiguračných súborov môžete upraviť pomocou premenných prostredia XDG_CONFIG_HOME alebo XDG_CONFIG_DIRS.

Na Windows sú adresáre APPDATA a LOCALAPPDATA preferovanými umiestneniami pre konfiguračný súbor.

Po načítaní globálnej konfigurácie wlc načíta najbližší projektový konfiguračný súbor z aktuálneho adresára alebo jeho rodičov:

.weblate, .weblate.ini, weblate.ini

Projektový konfiguračný súbor umiestnený v repozitári.

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.

Načíta sa iba najbližší projektový konfiguračný súbor. Konfiguračné súbory vo vzdialenejších rodičovských adresároch sa ignorujú.

Nasledujúce nastavenia možno nakonfigurovať v sekcii [weblate] (môžete toto prispôsobiť pomocou --config-section):

key

Removed in version 1.17: Použite sekciu [keys] na špecifikáciu kľúčov obmedzených na jednotlivé URL API, pozri Staršia konfigurácia.

url

URL servera API, predvolene 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.

Konfiguračný súbor je súbor INI, napríklad:

[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

Kľúče API sú uložené v sekcii [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.

Zmenené vo verzii 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.

V CI musia neobmedzené kľúče explicitne pripnúť URL API: nastavte oba WLC_URL a WLC_KEY, alebo použite --url spolu s --key.

Premenné prostredia

Added in version 1.18.0.

Zmenené vo verzii 2.0.1: Neobmedzené kľúče API vyžadujú explicitnú URL API, keď sa konfigurácia projektu objaví automaticky. Kľúče API sú odmietané cez nelokálne URL http://, pokiaľ nie je explicitne povolené nezabezpečené HTTP.

Zmenené vo verzii 2.2.0: Insecure HTTP and TLS environment overrides require WLC_URL when the API URL would otherwise come from automatically discovered project configuration.

URL API a kľúč možno nakonfigurovať aj pomocou premenných prostredia. Toto je obzvlášť užitočné pre pracovné postupy CI, kde WLC_URL pripína cieľ a WLC_KEY sa vstrekuje ako tajomstvo:

WLC_URL

URL API

WLC_KEY

Kľúč API. Keď by URL API inak pochádzala z automaticky objavenej konfigurácie projektu, WLC_KEY sa prijíma iba spolu s WLC_URL. Kľúče API sú predvolene odmietané cez nelokálne URL http://.

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.

Priorita konfigurácie URL API a kľúča (od najvyššej po najnižšiu) je:

1. Argumenty príkazového riadku (--url, --key).

2. Premenné prostredia (WLC_URL, WLC_KEY).

3. Konfigurácia načítaná z --config, alebo z objavenej globálnej konfigurácie plus najbližšej projektovej konfigurácie, keď sa --config nepoužíva.

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.

Príklady

Vypísať aktuálnu verziu programu:

$ wlc version

Vypísať všetky projekty:

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

Nahrať prekladový súbor:

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

Môžete tiež určiť, na ktorom projekte má wlc pracovať:

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

S týmto nastavením je ľahké zapísať čakajúce zmeny v aktuálnom projekte:

$ wlc commit