Difference between revisions of "LingoBot Users Guide"

From Lingoport Wiki
Jump to: navigation, search
(Available Commands Overview)
Line 23: Line 23:
 
* Example: <code>list projects LRM </code>
 
* Example: <code>list projects LRM </code>
   
  +
==== Run Project: ====
  +
'''<code>run project <group>.<project>:<branch></code>'''
  +
* Scans for any internationalization issues and displays a summary of the scan results.
   
 
==== Help: ====
 
==== Help: ====
Line 56: Line 59:
 
'''<code>notify stop <group>.<project>[:<branch>]</code>'''
 
'''<code>notify stop <group>.<project>[:<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.
 

Revision as of 05:35, 26 December 2023

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:

duplicate project <group>.<project>:<branch>

  • Creates a child project based on the branch name (source cannot be a child project).
  • Shorthand: dup proj

Delete Project:

delete project <group>.<project>:<branch>

  • Deletes the specified child project.
  • Shorthand: del proj

Show Command Center:

show command center[ <group>.<project>[:<branch>]]

  • Displays the URL of the dashboard corresponding to the specified project.
  • Shorthand: show command

List Projects:

list projects[ <query>]

  • Displays a list of active projects (optionally containing the query )
  • Example: list projects LRM

Run Project:

run project <group>.<project>:<branch>

  • Scans for any internationalization issues and displays a summary of the scan results.

Help:

help[ <query>]

  • Displays a list of all available commands, filtered by the query if it is specified.


LRM Only

Critical Errors:

show errors <group>.<project>[:<branch>]

  • Displays top 10 LRM-critical errors in the specified project/branch.

Pseudo-localize:

pseudoloc <group>.<project>:<branch>

  • Pseudo-localizes the specified project and pushes it to the repository.

Translate:

translate <group>.<project>:<branch>

  • If there are no errors in the specified project/branch, send the project resource files to the translation vendor.

Translation Status:

translation status [-a] <group>.<project>[:<branch>]

  • Displays a summary of the current status of translations on the specified project/branch.
  • Shorthand: tran stat

Example: translation status <group_name>.<project_name>:<branch>

Notify:

  • Manages the notification dispatch system for translation imports

notify me <group>.<project>[:<branch>]

  • Adds sender (user or room) to recipient list

notify who <group>.<project>[:<branch>]

  • Displays recipient list

notify stop <group>.<project>[:<branch>]

  • Removes sender (user or room) from recipient list