Difference between revisions of "LingoBot Users Guide"

From Lingoport Wiki
Jump to: navigation, search
(→‎Available Commands Overview)
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 Lingoport dashboard, 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.
 +
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[ --force] <group>.<project>:<branch></code>'''
 +
'''<code>duplicate project <group>.<project>:<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).
  
* Creates a child project based on the branch name (source cannot be a child project).
−
* Shorthand: '''<code>dup proj</code>, <code>-f</code>'''
 +
* Shorthand: '''<code>dup proj</code>'''
   
 
==== Delete Project: ====
  
==== Delete Project: ====
Line 14: Line 13:
 
* Shorthand: '''<code>del proj</code>'''
  
* Shorthand: '''<code>del proj</code>'''
   
−
==== Update Dashboard: ====
 +
==== Show Command Center: ====
−
'''<code>update dashboard <group>.<project>[:<branch>]</code>'''
 +
'''<code>show command center[ <group>.<project>[:<branch>]]</code>'''
−
* 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.
  
* Displays the URL of the dashboard corresponding to the specified project.
−
* Shorthand: '''<code>show dash</code>'''
 +
* Shorthand: '''<code>show command</code>'''
   
 
==== List Projects: ====
  
==== List Projects: ====
Line 29: Line 23:
 
* Example: <code>list projects LRM </code>
  
* Example: <code>list projects LRM </code>
   
−
==== Ping: ====
  
−
'''<code>ping</code>'''
  
−
* Replies with "PONG".
  
−
* A way to test the LingoBot connectivity.
  
−  
−
==== Cleanup: ====
  
−
'''<code>cleanup</code>'''
  
−
* Deletes all projects whose branches no longer exist.
  
   
 
==== Help: ====
  
==== Help: ====
Line 42: Line 28:
 
* 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 ===
Line 56: Line 38:
 
* Pseudo-localizes the specified project and pushes it to the repository.
  
* Pseudo-localizes the specified project and pushes it to the repository.
   
−
==== Prep Kit (Translate): ====
 +
==== Translate: ====
−
'''<code>prep kit <group>.<project>:<branch></code>'''
 +
'''<code>translate <group>.<project>:<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: ====
Line 65: Line 46:
 
* 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>'''
  
* Shorthand: '''<code>tran stat</code>'''
  +
Example: <code>translation status <group_name>.<project_name>:<branch></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: ====
Line 78: Line 57:
 
* Removes sender (user or room) from recipient list
  
* Removes sender (user or room) from recipient list
   
−
=== Globalyzer Lite Only ===
 +
==== Run Project: ====
  +
'''<code>run project <group>.<project>:<branch></code>'''
−
==== I18n Scan: ====
  
  +
* Scans for any internationalization issues and displays a summary of the scan results.
−
'''<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.
  

Revision as of 05:34, 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


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

Run Project:

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

  • Scans for any internationalization issues and displays a summary of the scan results.
Retrieved from "http://wiki.lingoport.com/index.php?title=LingoBot_Users_Guide&oldid=98132"