Weblate istemcisi

Kurulum

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

Ayrıca uvx ile doğrudan çalıştırabilirsiniz:

uvx wlc --help

İpucu

wlc bir Python modülü olarak da kullanılabilir. Ayrıntılı bilgi almak için: wlc.

Docker kullanımı

Weblate istemcisi, Docker kalıbı olarak da kullanılabilir.

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

Kurulum:

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.

Kapsayıcıyı başlatma komutu şu söz dizimini kullanır:

docker run --rm weblate/wlc [WLC_ARGS]

Örnek:

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

Yapılandırma dosyaları dosyanızı Docker kapsayıcısına aktarmak isteyebilirsiniz. Deponuzda .weblate gibi bir proje yapılandırması bulunduğunda, en kolay yaklaşım var olan klasörünüzü /home/weblate birimi olarak eklemektir:

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.

Başlarken

Başlamanın en kolay yolu, ~.config/weblate içinde kişisel bir wlc yapılandırması oluşturmaktır (tam keşif kuralları ve diğer konumlar ile ilgili ayrıntılı bilgi almak için: Yapılandırma dosyaları):

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

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

Ardından varsayılan sunucuda komutları yürütebilirsiniz:

wlc ls
wlc commit sandbox/hello-world

Ayrıca bakınız

Yapılandırma dosyaları

Eski yapılandırma

1.17 sürümünde değişti: Kapsamsız key kullanan eski yapılandırma artık desteklenmiyor.

2.2.0 sürümünde değişti: Global allow_insecure_http configuration is no longer supported. Configure an origin in the [insecure_http] section instead.

Eski yapılandırmayı aktarın:

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

Bir API adresi bulunan anahtar kapsamlı bir yapılandırmaya:

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

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

Özet

wlc [arguments] <command> [options]

Komutlar aslında hangi işlemin yapılması gerektiğini belirtir.

Açıklama

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

Argümanlar

Çıktı biçimini veya hangi Weblate kopyasının kullanılacağını tanımlamak için aşağıdaki bağımsız değişkenler kullanılabilir. Bunlar herhangi bir komuttan önce yazılmalıdır.

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

API adresini belirtir. Yapılandırma dosyasındaki tüm değerlerin yerini alır. Ayrıntılı bilgi almak için: Yapılandırma dosyaları. Adres /api/ ile bitmelidir. Örnek: https://hosted.weblate.org/api/.

--key KEY

Specify the API user key to use. Overrides any value found in the configuration file, see Yapılandırma dosyaları. 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

Yapılandırmayı yalnızca keşfedilen genel ve proje yapılandırma dosyaları yerine PATH üzerinden yükleyin. Ayrıntılı bilgi almak için: Yapılandırma dosyaları.

--config-section SECTION

Selects the configuration file section to use instead of [weblate], see Yapılandırma dosyaları.

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 Yapılandırma dosyaları 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.

Komutlar

Kullanılabilecek komutlar şunlardır:

version

Geçerli sürümü yazdırır.

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

Bir Weblate nesnesinde (çeviri, bileşen ya da proje) yapılan değişiklikleri işler.

pull

Uzak depo değişikliklerini Weblate nesnesine (çeviri, bileşen ya da proje) çeker.

push

Weblate nesnesindeki (çeviri, bileşen ya da proje) değişiklikleri uzak depoya iter.

reset

Uzak depoyla eşleşmesi için Weblate nesnesindeki (çeviri, bileşen ya da proje) değişiklikleri sıfırlar.

cleanup

Uzak depoyla eşleşmesi için bir Weblate nesnesindeki (çeviri, bileşen ya da proje) izlenmeyen değişiklikleri siler.

repo

Belirli bir Weblate nesnesi (çeviri, bileşen ya da proje) için depo durumunu görüntüler.

stats

Belirli bir Weblate nesnesi (çeviri, bileşen ya da proje) için ayrıntılı istatistikleri görüntüler.

lock-status

Displays the lock status of a component.

lock

Weblate bileşenini kilitleyerek üzerinde daha fazla çeviri yapılmasını engeller.

unlock

Weblate bileşeninin kilidini açarak çeviri yapılmasını sağlar.

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

Bir çeviri dosyasını yükler.

--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 İçe aktarma yöntemleri. The default is translate.

--fuzzy {process,approve}

Selects processing of fuzzy strings (marked for edit).

--author-name NAME

Geçerli kullanıcı yerine kullanılacak yazar adı

--author-email EMAIL

Geçerli kullanıcı yerine kullanılacak yazar e-posta adresi

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.

İpucu

Komutların kullanımı ile ilgili ayrıntılı bilgi almak için --help seçeneğini kullanabilirsiniz. Örneğin: wlc ls --help.

Yapılandırma dosyaları

--config seçeneği belirtildiğinde, wlc yalnızca o dosyayı yükler.

--config seçeneği olmadan, wlc önce keşfedilen genel yapılandırma dosyasını standart platforma özgü konumlardan yükler:

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

Windows üzerinde gezici profildeki genel yapılandırma dosyası.

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

Windows üzerinde yerel profildeki genel yapılandırma dosyası.

~/.config/weblate

Unix benzeri sistemlerdeki genel yapılandırma dosyası.

~/.config/weblate.ini

Alternative global configuration filename on Unix-like systems.

/etc/xdg/weblate

Sistem geneli varsayılan yapılandırma dosyası.

/etc/xdg/weblate.ini

Alternative system-wide fallback filename.

Program XDG teknik özelliklerine uyar. Böylece XDG_CONFIG_HOME ya da XDG_CONFIG_DIRS ortam değişkenlerine göre yapılandırma dosyalarının konumunu ayarlayabilirsiniz.

Windows üzerinde yapılandırma dosyası için APPDATA veya LOCALAPPDATA klasörlerinin kullanılması yeğlenir.

Genel yapılandırmayı yükledikten sonra, wlc en yakın proje yapılandırma dosyasını geçerli klasörden veya üst klasörlerinden yükler:

.weblate, .weblate.ini, weblate.ini

Depoya yerleştirilmiş proje yapılandırma dosyası.

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.

Yalnızca en yakın proje yapılandırma dosyası yüklenir. Daha uzak üst klasörlerdeki yapılandırma dosyaları göz ardı edilir.

[weblate] bölümünde şu ayarlar yapılandırılabilir (bunu --config-section ile özelleştirebilirsiniz):

key

Removed in version 1.17: Bireysel API adresleri için kapsamlı anahtarları belirtmek için [keys] bölümünü kullanın. Ayrıntılı bilgi almak için: Eski yapılandırma.

url

API sunucusunun adresi. Varsayılan değer: 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.

Yapılandırma dosyası bir INI dosyasıdır. Örneğin:

[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

API anahtarları [keys] bölümünde tutulur:

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

2.2.0 sürümünde değişti: 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.

Ortam değişkenleri

Added in version 1.18.0.

2.0.1 sürümünde değişti: 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.

2.2.0 sürümünde değişti: 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

API adresi

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. Komut satırı parametreleri (--url, --key).

2. Ortam değişkenleri (WLC_URL, WLC_KEY).

3. Yapılandırma --config seçeneğinden veya keşfedilen genel yapılandırmaya ek olarak --config kullanılmadığında en yakın proje yapılandırmasından yüklenir.

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.

Örnekler

Geçerli program sürümünü yazdır:

$ wlc version

Tüm projeleri listele:

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

Çeviri dosyasını yükle:

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

Ayrıca wlc hangi proje üzerinde çalışacak onu da belirleyebilirsiniz:

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

Bu kurulumla, geçerli projede bekleyen değişiklikler kolayca işlenebilir:

$ wlc commit