Difference between revisions of "LingoBot Users Guide"
(→Pseudo-localize:) |
(→Duplicate Project:) |
||
| (26 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== Available Commands Overview == |
== Available Commands Overview == |
||
| − | LingoBot allows developers and i18n/l10n managers to make use of Lingoport's product suite without ever having to leave their collaboration environment. With a variety of easy-to-understand commands, users can scan their codebase for potential i18n and l10n issues, gain quick access to the |
+ | LingoBot allows developers and i18n/l10n managers to make use of Lingoport's product suite without ever having to leave their collaboration environment. With a variety of easy-to-understand commands, users can scan their codebase for potential i18n and l10n issues, gain quick access to the Command Center, as well as send resource files for translation and retrieve translation status reports. Here you will find a summary list of the commands which LingoBot will recognize as well as a brief description of each command. Further down you will find in-depth breakdowns of the commands, their use cases, as well as examples of each command in use. If you have any questions that this document doesn't answer, be sure to check out the FAQ page for additional information. |
=== Universal === |
=== Universal === |
||
==== Duplicate Project: ==== |
==== Duplicate Project: ==== |
||
| − | '''<code>duplicate project |
+ | '''<code>lingobot duplicate project <full_project_name>:(<new_branch></code>)''' |
| + | * Creates a child project based on the branch name. |
||
| − | * If the force flag is included, a new git branch of the same name will also be created. |
||
| + | * Shorthand: '''<code>lingobot dup proj</code>''' |
||
| − | * Creates a child project based on the branch name (source cannot be a child project). |
||
| − | * Shorthand: '''<code>dup proj</code>, <code>-f</code>''' |
||
==== Delete Project: ==== |
==== Delete Project: ==== |
||
| − | '''<code>delete project <group>.<project> |
+ | '''<code>lingobot delete project <group>.<project>.<module>(<branch>)</code>''' |
* Deletes the specified child project. |
* Deletes the specified child project. |
||
| − | * Shorthand: '''<code>del proj</code>''' |
||
| − | ==== |
+ | ==== Show Command Center: ==== |
| − | '''<code> |
+ | '''<code>lingobot show command center</code>''' |
| + | * Displays the URL of the dashboard corresponding . |
||
| − | * Updates the dashboard with the latest information from the specified project/branch. |
||
| − | * Shorthand: '''<code>up dash</code>''' |
||
| − | |||
| − | ==== Show Dashboard: ==== |
||
| − | '''<code>show dashboard[ <group>.<project>[:<branch>]]</code>''' |
||
| − | * Displays the URL of the dashboard corresponding to the specified project. |
||
| − | * Shorthand: '''<code>show dash</code>''' |
||
==== List Projects: ==== |
==== List Projects: ==== |
||
| − | '''<code>list projects[ <query>]</code>''' |
+ | '''<code>lingobot list projects[ <query>]</code>''' |
* Displays a list of active projects (optionally containing the query ) |
* Displays a list of active projects (optionally containing the query ) |
||
* Example: <code>list projects LRM </code> |
* Example: <code>list projects LRM </code> |
||
| − | ==== |
+ | ==== Run Project: ==== |
| − | '''<code> |
+ | '''<code>lingobot run project <group>.<project>.<module>(<branch>)</code>''' |
| + | * Scans for any internationalization issues and displays a summary of the scan results. |
||
| − | * Replies with "PONG". |
||
| − | * A way to test the LingoBot connectivity. |
||
| − | |||
| − | ==== Cleanup: ==== |
||
| − | '''<code>cleanup</code>''' |
||
| − | * Deletes all projects whose branches no longer exist. |
||
==== Help: ==== |
==== Help: ==== |
||
| − | '''<code>help[ <query>]</code>''' |
+ | '''<code>lingobot help[ <query>]</code>''' |
* Displays a list of all available commands, filtered by the query if it is specified. |
* Displays a list of all available commands, filtered by the query if it is specified. |
||
| − | |||
| − | ==== Status: ==== |
||
| − | '''<code>status</code>''' |
||
| − | * Report the status of any request that is actively awaiting a response. |
||
| − | * If there are no requests pending a response, the status will be 'Idle'. |
||
=== LRM Only === |
=== LRM Only === |
||
==== Critical Errors: ==== |
==== Critical Errors: ==== |
||
| − | '''<code>show errors <group>.<project> |
+ | '''<code>lingobot show errors <group>.<project>.<module>(<branch>)</code>''' |
* Displays top 10 LRM-critical errors in the specified project/branch. |
* Displays top 10 LRM-critical errors in the specified project/branch. |
||
==== Pseudo-localize: ==== |
==== Pseudo-localize: ==== |
||
| − | '''<code>pseudoloc <group>.<project> |
+ | '''<code>lingobot pseudoloc <group>.<project>.<module>(<branch>)</code>''' |
* Pseudo-localizes the specified project and pushes it to the repository. |
* Pseudo-localizes the specified project and pushes it to the repository. |
||
| − | ==== |
+ | ==== Translate: ==== |
| − | '''<code> |
+ | '''<code>lingobot translate <group>.<project>.<module>(<branch>)</code>''' |
* If there are no errors in the specified project/branch, send the project resource files to the translation vendor. |
* If there are no errors in the specified project/branch, send the project resource files to the translation vendor. |
||
| − | * Alternative: <code>translate</code> |
||
==== Translation Status: ==== |
==== Translation Status: ==== |
||
| − | '''<code>translation status |
+ | '''<code>lingobot translation status <group>.<project>.<module>(<branch>)</code>''' |
* Displays a summary of the current status of translations on the specified project/branch. |
* Displays a summary of the current status of translations on the specified project/branch. |
||
| − | * Shorthand: '''<code>tran stat</code>''' |
||
| − | * Optional: Include the all flag (-a) to show all translation status instead of the first 10 locales. |
||
| − | * Use | to divide locales to show specific language translation status. |
||
| − | Example: <code>translation status <group_name>.<project_name>:<branch>|<locale1>|<locale2></code> |
||
==== Notify: ==== |
==== Notify: ==== |
||
* Manages the notification dispatch system for translation imports |
* Manages the notification dispatch system for translation imports |
||
| − | '''<code>notify me <group>.<project> |
+ | '''<code>lingobot notify me <group>.<project>.<module>(<branch>)</code>''' |
* Adds sender (user or room) to recipient list |
* Adds sender (user or room) to recipient list |
||
| − | '''<code>notify who <group>.<project> |
+ | '''<code>lingobot notify who <group>.<project>.<module>(<branch>)</code>''' |
* Displays recipient list |
* Displays recipient list |
||
| − | '''<code>notify stop <group>.<project> |
+ | '''<code>lingobot notify stop <group>.<project>.<module>(<branch>)</code>''' |
* Removes sender (user or room) from recipient list |
* Removes sender (user or room) from recipient list |
||
| − | |||
| − | === Globalyzer Lite Only === |
||
| − | ==== I18n Scan: ==== |
||
| − | '''<code>i18n scan <group>.<project>:<branch></code>''' |
||
| − | * Scans the differences between the branch and its parent for any internationalization issues and displays a summary of the scan results. |
||
| − | |||
| − | === Batch === |
||
| − | ==== Create Batch project ==== |
||
| − | '''<code>add <project> to <batch></code>''' |
||
| − | * Create the <batch> and add <project> to it |
||
| − | |||
| − | ==== Duplicate Project: ==== |
||
| − | '''<code>duplicate project[ --force] <batch>:<branch></code>''' |
||
| − | * If the force flag is included, a new git branch of the same name will also be created. |
||
| − | * Creates a child project based on the branch name (source cannot be a child project). |
||
| − | * Shorthand: '''<code>dup proj</code>''' |
||
| − | |||
| − | ==== Delete Project: ==== |
||
| − | '''<code>delete project <batch></code>''' |
||
| − | * Delete the batch project, but leave the projects that were the components alone and in the list. |
||
| − | * Shorthand: '''<code>del proj</code> |
||
| − | ''' |
||
| − | |||
| − | ==== Update Dashboard: ==== |
||
| − | '''<code>update dashboard <batch></code>''' |
||
| − | * Updates the dashboard with the latest information from all projects in the batch. |
||
| − | * Shorthand: '''<code>up dash</code>''' |
||
| − | |||
| − | ==== Show Dashboard: ==== |
||
| − | '''<code>show dashboard <batch></code>''' |
||
| − | * Displays the URL of the dashboard corresponding all the projects in the batch. |
||
| − | * Shorthand: '''<code>show dash</code>''' |
||
| − | |||
| − | ==== List Projects: ==== |
||
| − | '''<code>list projects <batch></code>''' |
||
| − | * Displays a list of all the projects in the batch. |
||
| − | * Shorthand: '''<code>list proj</code>''' |
||
| − | |||
| − | ==== Remove project from batch: ==== |
||
| − | '''<code>remove <project> from <batch></code>''' |
||
| − | * Remove projects from a batch, but leave them in the list of projects. |
||
| − | |||
| − | ==== LRM Only ==== |
||
| − | ==== Critical Errors: ==== |
||
| − | '''<code>show errors <group>.<project>:<branch1>:<branch2></code> ''' |
||
| − | |||
| − | '''<code>show errors <batch></code>''' |
||
| − | * Displays top 10 LRM-critical errors in the specified project/branch. |
||
| − | |||
| − | ==== Pseudo-localize: ==== |
||
| − | '''<code>pseudoloc <group>.<project>:<branch1>:<branch2></code'''> |
||
| − | |||
| − | '''<code>pseudoloc <batch></code>''' |
||
| − | * Pseudo-localizes the specified project and branches. |
||
| − | |||
| − | ==== Prep Kit (Translate): ==== |
||
| − | * <code>prep kit <group>.<project>:<branch1>:<branch2></code> or <code>prep kit <batch></code> |
||
| − | * If there are no errors in the specified project/branch, sends the project to the translation vendor. |
||
| − | * Alternative: translate |
||
| − | ==== Translation Status: ==== |
||
| − | * <code>translation status <group>.<project>:<branch1>:<branch2></code> or <code>translation status <batch></code> |
||
| − | * Displays a summary of the current status of translations on the specified project/branch. |
||
| − | * Shorthand: tran stat |
||
| − | ==== Globalyzer Lite Only ==== |
||
| − | ==== I18n Scan: ==== |
||
| − | * <code>i18n scan <group>.<project>:<branch1>:<branch2></code> or <code>i18n scan <batch></code> |
||
| − | * Scans differences between the branch and its parent for any i18n issues and displays a summary of the scan results. |
||
Latest revision as of 19:32, 26 March 2024
Contents
Available Commands Overview
LingoBot allows developers and i18n/l10n managers to make use of Lingoport's product suite without ever having to leave their collaboration environment. With a variety of easy-to-understand commands, users can scan their codebase for potential i18n and l10n issues, gain quick access to the Command Center, as well as send resource files for translation and retrieve translation status reports. Here you will find a summary list of the commands which LingoBot will recognize as well as a brief description of each command. Further down you will find in-depth breakdowns of the commands, their use cases, as well as examples of each command in use. If you have any questions that this document doesn't answer, be sure to check out the FAQ page for additional information.
Universal
Duplicate Project:
lingobot duplicate project <full_project_name>:(<new_branch>)
- Creates a child project based on the branch name.
- Shorthand:
lingobot dup proj
Delete Project:
lingobot delete project <group>.<project>.<module>(<branch>)
- Deletes the specified child project.
Show Command Center:
lingobot show command center
- Displays the URL of the dashboard corresponding .
List Projects:
lingobot list projects[ <query>]
- Displays a list of active projects (optionally containing the query )
- Example:
list projects LRM
Run Project:
lingobot run project <group>.<project>.<module>(<branch>)
- Scans for any internationalization issues and displays a summary of the scan results.
Help:
lingobot help[ <query>]
- Displays a list of all available commands, filtered by the query if it is specified.
LRM Only
Critical Errors:
lingobot show errors <group>.<project>.<module>(<branch>)
- Displays top 10 LRM-critical errors in the specified project/branch.
Pseudo-localize:
lingobot pseudoloc <group>.<project>.<module>(<branch>)
- Pseudo-localizes the specified project and pushes it to the repository.
Translate:
lingobot translate <group>.<project>.<module>(<branch>)
- If there are no errors in the specified project/branch, send the project resource files to the translation vendor.
Translation Status:
lingobot translation status <group>.<project>.<module>(<branch>)
- Displays a summary of the current status of translations on the specified project/branch.
Notify:
- Manages the notification dispatch system for translation imports
lingobot notify me <group>.<project>.<module>(<branch>)
- Adds sender (user or room) to recipient list
lingobot notify who <group>.<project>.<module>(<branch>)
- Displays recipient list
lingobot notify stop <group>.<project>.<module>(<branch>)
- Removes sender (user or room) from recipient list
