Uploading source content to Transifex
Outdated article
All developer documentation has moved to Transifex Developer Hub. Read this article here.
After the strings have been marked for translation in the code, you can push them to Transifex.
In order to be able to do so, first make sure that @transifex/cli library is installed either locally using the command
$ npm install @transifex/cli --save
or globally using
$ npm install -g @transifex/cli
Then call the command line using:
$ npx txjs-cli push <SRC_FOLDER> --token=<PROJECT_TOKEN> --secret=<PROJECT_SECRET>
or for global installation
$ txjs-cli push <SRC_FOLDER> --token=<PROJECT_TOKEN> --secret=<PROJECT_SECRET>
Apart from passing credentials to the command line, you can also set them as environment variables:
$ export TRANSIFEX_TOKEN=<PROJECT_TOKEN>
$ export TRANSIFEX_SECRET=<PROJECT_SECRET>
$ txjs-cli push <SRC_FOLDER>
This command works in two phases:
- First, it goes through all the files of the current directory (and subdirectories) and collects all translatable strings in memory
- Then, it contacts Transifex and pushes the strings with all the metadata to the project (and resource) that is associated with the token you have given during setup
This way, the source strings reach Transifex and become available for translation.
Push command options
Here is a full list of command line options:
USAGE
$ txjs-cli push [PATTERN]
ARGUMENTS
PATTERN [default: **/*.{js,jsx,ts,tsx}] file pattern to scan for strings
OPTIONS
-v, --verbose verbose output
--append-tags=append-tags append tags to strings
--cds-host=cds-host CDS host URL
--dry-run dry run, do not push to Transifex
--key-generator=source|hash [default: source] use hashed or
source based keys
--no-wait disable polling for upload results
--purge purge content on Transifex
--secret=secret native project secret
--token=token native project public token
--with-tags-only=with-tags-only push strings with specific tags
--without-tags-only=without-tags-only push strings without specific tags
DESCRIPTION
Parse .js, .ts, .jsx, .tsx and .html files and detect phrases marked for
translation by Transifex Native toolkit for Javascript and
upload them to Transifex for translation.
To push content some environment variables must be set:
TRANSIFEX_TOKEN=<Transifex Native Project Token>
TRANSIFEX_SECRET=<Transifex Native Project Secret>
(optional) TRANSIFEX_CDS_HOST=<CDS HOST>
or passed as --token=<TOKEN> --secret=<SECRET> parameters
Default CDS Host is https://cds.svc.transifex.net
Examples:
txjs-cli push -v
txjs-cli push src/
txjs-cli push /home/repo/src
txjs-cli push "*.js"
txjs-cli push --dry-run
txjs-cli push --no-wait
txjs-cli push --key-generator=hash
txjs-cli push --append-tags="master,release:2.5"
txjs-cli push --with-tags-only="home,error"
txjs-cli push --without-tags-only="custom"
txjs-cli push --token=mytoken --secret=mysecret
TRANSIFEX_TOKEN=mytoken TRANSIFEX_SECRET=mysecret txjs-cli push