Commands

All available commands for the Symphony framework could be listed using bin/console list

Available custom commands for the translation tool:

• dokuwiki:addRepo
  Adds a repository
• dokuwiki:cleanupTranslationUpdates
  Deletes incomplete, sent or failed (older than 1 day) translation updates (all or per repository)
• dokuwiki:deleteRepo
  Delete a repository
• dokuwiki:editRepo
  Let edit some properties of repository. Supported: giturl, branch, state, email, englishReadonly
• dokuwiki:setup
  Prepare software for first run. If not existing add dokuwiki as core repository and add missing languages
• dokuwiki:showInfo
  Show status for maintenance for all or a specific repo, or basic info for all
• dokuwiki:softReset
  Reset lock, tmp folder, error count and last updated
• dokuwiki:updateDwApi
  Update cache from dokuwiki api (daily cron job)
• dokuwiki:updateGit
  Update local git repositories (and eventually the fork) and send pending translations (regular cron job)
• dokuwiki:updateLanguages
  Updates all language information from local repository. Refreshes the cached translation objects. Needed if changing the cached translations objects (e.g. due changes in LanguageFileParser, LocalText)

Usage

bin/console dokuwiki:addRepo [...your arguments...]

The translation tool runs two cron jobs, the other commands are for manual administration tasks.

See also

• Cronjob overview
• Administration tasks: https://www.dokuwiki.org/teams:translate-tool

For running a command in production you should add --env=prod to the command.

Documentation per command

bin/console help dokuwiki:addRepo

Description:
  Adds a repository

Usage:
  dokuwiki:addRepo <type> <name> <gitUrl> <branch> <email> [<englishReadonly> [<displayName> [<author> [<popularity>]]]]

Arguments:
  type                  Repository type: `core`, `plugin` or `template`
  name                  Name of the repository (lower case, no special chars or blanks, as on dokuwiki.org)
  gitUrl                Public git url
  branch                Default branch
  email                 Author email address
  englishReadonly       If readonly, English translations can not be submitted in the tool. (`true`=readonly) [default: "true"]
  displayName           Template/plugin name to display
  author                Author name (updated later from dokuwiki.org) [default: ""]
  popularity            Popularity value (used to sort)  (updated later from dokuwiki.org) [default: 0]

Generic (available for all commands):

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
  -e, --env=ENV         The Environment name. [default: "dev"]
      --no-debug        Switch off debug mode.
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

bin/console help dokuwiki:cleanupTranslationUpdates

Description:
  Deletes incomplete, sent or failed (older than 1 day) translation updates (`all` or per repository)

Usage:
  dokuwiki:cleanupTranslationUpdates <type> [<name>]

Arguments:
  type       `template`, `plugin` or `core`. Or `all` for cleaning all repositories; `all-dry` shows summary without deleting.
  name       repository name

bin/console help dokuwiki:deleteRepo

Description:
  Delete a repository

Usage:
  dokuwiki:deleteRepo <type> <name>

Arguments:
  type       `template`, `plugin` or `core`
  name       repository name

bin/console help dokuwiki:editRepo

Description:
  Let edit some properties of repository. Supported: `giturl`, `branch`, `state`, `email`, `englishReadonly`

Usage:
  dokuwiki:editRepo <type> <name> <property> [<value>]

Arguments:
  type        `template`, `plugin` or `core`
  name        repository name
  property    property name
  value       string or true/false, if no value given current value is shown

bin/console help dokuwiki:setup

Description:
  Prepare software for first run. If not existing add dokuwiki as core repository and add missing languages

Usage:
  dokuwiki:setup

bin/console help dokuwiki:showInfo

Description:
  Show status for maintenance for all or a specific repo, or basic info for all

Usage:
  dokuwiki:showInfo [<type> [<name> [<showmore>]]]

Arguments:
  type       `template`, `plugin` or `core`. Or `onlyerrors` for filtering or `basicinfo` for urls/branch/email listing.
  name       repository name
  showmore   `showmore` shows the entire error of the translation updates. (only if showing a single repo)

bin/console help dokuwiki:softReset

Description:
  Reset lock, tmp folder, error count and last updated

Usage:
  dokuwiki:softReset <type> <name>

Arguments:
  type       `template`, `plugin` or `core`
  name       repository name

bin/console help dokuwiki:updateGit

Description:
  Update local git repositories (and eventually the fork) and send pending translations

Usage:
  dokuwiki:updateGit

bin/console help dokuwiki:updateDwApi

Description:
  Update cache from dokuwiki api

Usage:
  dokuwiki:updateDwApi

bin/console help dokuwiki:updateLanguages

Description:
  Updates all language information from local repository. Refreshes the cached translation objects

Usage:
  dokuwiki:updateLanguages