Difference between revisions of "LingoBot Users Guide"
(→Available Commands Overview) |
(→Duplicate Project:) |
||
| (19 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
=== 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 |
+ | * Creates a child project based on the branch name. |
| − | * Shorthand: '''<code>dup proj</code>''' |
+ | * Shorthand: '''<code>lingobot dup proj</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: ==== |
==== Show Command Center: ==== |
||
| − | '''<code>show command center |
+ | '''<code>lingobot show command center</code>''' |
| − | * Displays the URL of the dashboard corresponding |
+ | * Displays the URL of the dashboard corresponding . |
| − | * Shorthand: '''<code>show command</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>lingobot run project <group>.<project>.<module>(<branch>)</code>''' |
||
| + | * Scans for any internationalization issues and displays a summary of the scan results. |
||
==== 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. |
||
| − | |||
=== 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: ==== |
==== Translate: ==== |
||
| − | '''<code>translate <group>.<project> |
+ | '''<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. |
||
==== 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>''' |
||
| − | Example: <code>translation status <group_name>.<project_name>:<branch></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 |
||
| − | |||
| − | ==== Run Project: ==== |
||
| − | '''<code>run project <group>.<project>:<branch></code>''' |
||
| − | * Scans for any internationalization 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
