The translate5 CLI tool provides several useful functions.
When using the docker setup a command called "t5" is available in the translate5/php docker container.
On legacy installations change to your translate5 directory and call translate5.sh
Its purpose is to provide important commands to maintain translate5 on command line, and is replacing install-and-update2.sh and in future the whole additional maintenance functionality of install-and-update.sh so that only installing and updating remains in install-and-update.sh
A Bash completion file is available in "ProjectRoot/Translate5/translate5.sh.bash-completion"
API usage / t5 auth:apptoken:add command
For using translate5 via API the authentication against the API must be done via an app token (starting with version 5.8.2 / 5.8.3).
Authentication via username / password will not be possible anymore (for security reasons).
Currently the maintenance (add / delete / list) of tokens is only doable via translate5 CLI tool. See below.
The maintenance of tokens per user in the UI is planned, but funding is required.
T5 CLI commands
The following commands are available in t5 CLI (snapshot August 2026)
cd /var/www/translate5
t5 list
Translate5 CLI Maintenance 1.0
Usage:
command [options] [arguments]
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Available commands:
changelog Show the last changelog entries.
completion Dump the shell completion script
config List, get and set translate5 configuration values.
cron Trigger the internal cron jobs
help Display help for a command
list List commands
log [logx|logy] Query the translate5 log. Short cut logx shows errors and warnings only of the last 24h.logy all of the last 24h
status Prints a instance status.
auth
auth:apptoken:add Generates auth token used for authentication in translate5
auth:apptoken:delete Deletes auth token used for authentication in translate5
auth:apptoken:list Shows list of auth tokens used for authentication in translate5
auth:impersonate [session:impersonate] Returns a URL to authenticate password less as the given user.
auth:support [support] Returns a URL to authenticate passwordless as the support-user.
cache
cache:purge Cleans the application cache.
config
config:diff Compare configurations of tasks or customers
content-protection
content-protection:language-rules-hashes:refresh
database
database:backup Create database backup files
database:optimize Optimize database tables with high data fluctuation.
database:query [db:query] Execute SQL query on the database
database:segmentview:drop Drop materialized segment views.
database:stat Brief statistics about the database
database:update Maintain database updates.
filesystem
filesystem:external:check List and test all flysystem configurations in the application
hotfolder
hotfolder:export Starts a hotfolder-export for the provided tasks.
installer
installer:post-install Executes post installation scripts from application/post-installation-scripts
l10n
l10n:cleanup-xliffs Deletes all outdated XLIFF files used for localization
l10n:exchange-sources Exchanges all sources to the current localized english targets
l10n:extract Extracts the localization from the current source-code. Make sure, all sym-links for private plugins are set up, otherwise they will not be extracted
l10n:format Formats all localization-XLIFF's: Sorts the keys naturally & normalizes the whitespace
l10n:reimport Reimports the localizations from a localization-task.It is expected, that the localization-task is exported under it's original name and stored in /data/l10n or the localization-files are stored in locale-folders (/de, /en, ...) in this location .
l10n:taskcreate Pushes the localizations of the current instance into a translation/review task.
l10n:update Extracts and updates the localization from the current source-code. Make sure, all sym-links for private plugins are set up, otherwise they will not be extracted correctly
l10n:upgrade-clientspecific Upgrades existing client-specific localizations to the new "zxliff"-format
language
language:disable Disables a language.
language:enable Enables a language.
language:list Returns a list of all supported (configured) languages of translate5.
language-resource
language-resource:t5memory:specific-data:snapshot Snapshot the specificData for each t5memory language resource into a separate log file data/logs/t5memory-specificData.log
log
log:login Query the login log
log:php [plog|php:log] Traces the php-log, by default the last 25 lines
log:tojira Create a Jira issue from a translate5 log entry.
log:worker [wlog|worker:log] Traces the worker-log, by default the last 25 lines
maintenance
maintenance:announce Sends an announcement via email with the given time and message to the configured users.
maintenance:disable [maintenance:end|mnt:end|mnt:disable] Disable the maintenance mode.
maintenance:message [mnt:message|mnt:msg] Sets just a message in the maintenance announce message box to application users.
maintenance:notify [mnt:notify] Sends a message directly to all connected users (if messagebus enabled) which opens a popup to the user then.
maintenance:set [mnt:set] Sets the maintenance mode.
maintenance:status Returns information about the maintenance mode.
okapi
okapi:across:patchabbrevations Patches the abbrevations from an across settings-file onto an OKAPI SRX file
okapi:add Add a new okapi server
okapi:cleanbconfs Removes all BCONFs that do not have a valid /data folder, removes all orphaned data-folders. CAUTION: this potentially deletes user data! Also, the Frontend will have an invalid state
okapi:list List all configured okapi server's and their usage
okapi:purge Cleans the configured okapi versions
okapi:repackbconf Re-packs the BCONF of the given id or all
okapi:searchbconfs Searches for a string in all BCONFs / File-Format-Settings that are managed by the Installation
okapi:switch Switches the used OKAPI-version for the installation.
okapi:update Updates the configured okapi server to be used
okapi:upgrade-to-latest Adds the latest OKAPI version in the container to the available ones if not already existing and upgrades all configs using the current latest to that version
openai
openai:dump-prompts OpenAI: Dumps the existing prompts into an SQL string
openai:seed-rag-prompts Create X (default: 4) empty/template LLM prompts with Y (default: 3) examples
patch
patch:apply Applies git commits as patch to the code base.
patch:okapi146whitespace Analyzes tasks data for lost whitespaces.
patch:script Fixes data by script filename expected to be added to "Translate5/fixscripts"
plugin
plugin:disable Deactivate one or more plug-ins.
plugin:enable Activate one or more plug-ins.
plugin:list List all installed plugins.
plugin:remove Remove a plugin! DANGEROUS!
role
role:list Prints a list of current roles
segment
segment:history Shows the segment editing history, from the oldest to the current version.
segment:info Prints the segments main data.
segment:search Finds Segment by searching in source or target text.
segment:setcontent Sets a segment´s source/target.
service
service:autodiscovery Searches for common DNS names of used services and sets them in the configuration,
using the default ports.
service:check Checks all configured services (base & plugins) if they are setup & working correctly.
service:ping Simple tool to check availability of a TCP service
statistics
statistics:aggregate Aggregates segments history data into Statistics DB.
statistics:inspect Shows segment history aggregation data for one or more tasks.
statistics:levenshtein Calculate missing levenshtein values in segment history.
statistics:sqlite:init Create missing SQLite statistics DB/tables.
statistics:workflowstep:backfill Statistics migration: backfill editedInStep and task workflow log task-by-task.
system
system:check Checks the system requirements.
system:clean TODO: clean data export, call tbx:clean, task:clean → needs a summary option!
system:integrity Checks current installation files against installer integrity manifest.
system:mailtest Sends a test e-mail to the given address as argument.
system:messagebus:debug Messagebus debug
system:version [version] Prints the translate5 version.
t5connect
t5connect:setforeignstate Sets the foreign-state for a t5connect task.
t5memory
t5memory:clean-up Searches for orphaned memories and records without actual memories on t5memory side. Deletes files on t5memory side or removes invalid records.
t5memory:conversion:scheduleForAll
t5memory:create-duplicate-lr For every TM, that is assigned as writeable to a task, and that is not a task-TM create an empty duplicate with the same name and suffix _duplicate
t5memory:delete Reorganizes particular TM
t5memory:export Exports specified memories to the specified directory
t5memory:list Lists all translation memories in t5memory with statuses
t5memory:migrate Migrates all existing T5Memory language resources to t5memory
t5memory:reimport-task Reimport task segments into the t5memory. Reimports only those segments, that previously have been manually saved by a user.
t5memory:reorganize Reorganizes particular TM
t5memory:set-memories-from-server-to-language-resource Looks for memories on the t5memory side and sets them to language resources.
task
task:archive Triggers the configured task delete and archive entries for testing purposes
task:changesxlf Print / save the changes.xlf to a separate file
task:clean provides information about and the possibility to delete hanging import / erroneous tasks and orphaned task data directories
task:config Prints the task configuration (by default only the ones different from system)
task:downloaddata Download a tasks data-directory
task:export Exports a task by given id / taskGuid, optionally only specific files, filtered by fileId
task:export:clean Clean old artefacts from data/Export directory
task:frominstant Turns an task created with InstantTranslate to a normal task
task:import Import task
task:info Queries the task table and provides a listing of all found tasks, or detailed information if found only a single task.
task:log Query the log entries of a specific task.
task:segment:statistics Shows some segment statistics to a task.
task:skeletonfile List and show the content of a tasks import data skeleton file(s)
task:state:unconfirm [task:state:unapprove] Sets a task (not a job!) to not approved / unconfirmed.
task:unlock Unlocks a locked task.
tbx
tbx:clean cleans old TBX files
termportal
termportal:datatypecheck Checks the integrity of the term datatypes against the content in the attributes table. This is necessary due TRANSLATE-2797.
termportal:reindex Re-index the fulltext index of the term database.
user
user:create Creates a user via CLI.
user:info Returns information about one or more users in translate5.
user:invalidlogin:list Prints all entries of the invalid login list - a specific amount of entries leads to a locked user
user:invalidlogin:reset Unlocks a login locked user by removing its invalid login entries
user:online Prints which users are online.
user:update Updates user via CLI
visual
visual:convertlegacypdfs Visual: Converts all PDF based reviews using the legacy scroller
visual:implantreflow Visual: Implants the visual source file for the wysiwyg screen from one source task to one or more target tasks. The tasks must be supplied by their ID
visual:logs Shows the visual logs for a given task ordered newest to oldest
worker
worker:clean Removes all done workers from the worker table
worker:duration [wduration] Analyze worker.log and show queue/dispatch/run durations per worker
worker:list Prints a list of current workers or details about one worker
worker:queue Triggers the worker queue - may be necessary after an apache restart or maintenance mode.
worker:rerun Tries to re-run a specific worker identified by its ID.Must be in state done defunct or running.
worker:run Tries to run a specific waiting worker identified by its ID.
workflow
workflow:clone Clones a workflow completly.
workflow:list Prints a list of available workflows with steps and actions
workflow:step Manipulates and lists workflow steps.