Difference between revisions of "LingoBot Users Guide"

From Lingoport Wiki
Jump to: navigation, search
m
(Translation Status:)
 
(53 intermediate revisions by 3 users not shown)
Line 4: Line 4:
 
=== Universal ===
 
=== Universal ===
 
==== Duplicate Project: ====
 
==== Duplicate Project: ====
* duplicate project[ --force] <group>.<project>:<branch>
+
'''<code>duplicate project[ --force] <group>.<project>:<branch></code>'''
** If the force flag is included, a new git branch of the same name will also be created.
+
* 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: dup proj, -f
+
* Shorthand: '''<code>dup proj</code>, <code>-f</code>'''
  +
 
==== Delete Project: ====
 
==== Delete Project: ====
* delete project <group>.<project>:<branch>
+
'''<code>delete project <group>.<project>:<branch></code>'''
 
* Deletes the specified child project.
 
* Deletes the specified child project.
* Shorthand: del proj
+
* Shorthand: '''<code>del proj</code>'''
  +
 
==== Update Dashboard: ====
 
==== Update Dashboard: ====
* update dashboard <group>.<project>[:<branch>]
+
'''<code>update dashboard <group>.<project>[:<branch>]</code>'''
 
* Updates the dashboard with the latest information from the specified project/branch.
 
* Updates the dashboard with the latest information from the specified project/branch.
* Shorthand: up dash
+
* Shorthand: '''<code>up dash</code>'''
  +
 
==== Show Dashboard: ====
 
==== Show Dashboard: ====
* show dashboard[ <group>.<project>[:<branch>]]
+
'''<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: show dash
+
* Shorthand: '''<code>show dash</code>'''
  +
 
==== List Projects: ====
 
==== List Projects: ====
* list projects[ <query>]
+
'''<code>list projects[ <query>]</code>'''
* Displays list of active projects (optionally containing )
+
* Displays a list of active projects (optionally containing the query )
  +
* Example: <code>list projects LRM </code>
  +
 
==== Ping: ====
 
==== Ping: ====
  +
'''<code>ping</code>'''
* ping
 
* Replies with "PONG"
+
* Replies with "PONG".
  +
* A way to test the LingoBot connectivity.
  +
  +
==== Cleanup: ====
  +
'''<code>cleanup</code>'''
  +
* Deletes all projects whose branches no longer exist.
  +
 
==== Help: ====
 
==== Help: ====
* help[ <query>]
+
'''<code>help[ <query>]</code>'''
* Displays a list of all available commands, filtered by 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: ====
* show errors <group>.<project>[:<branch>]
+
'''<code>show errors <group>.<project>[:<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: ====
* pseudoloc <group>.<project>:<branch>
+
'''<code>pseudoloc <group>.<project>:<branch></code>'''
* Pseudo-localizes the specified project.
+
* Pseudo-localizes the specified project and pushes it to the repository.
  +
==== Prep Kit: ====
 
  +
==== Prep Kit (Translate): ====
* prep kit <group>.<project>:<branch>
 
  +
'''<code>prep kit <group>.<project>:<branch></code>'''
* If there are no errors in the specified project/branch, sends the project to the translation vendor.
 
  +
* If there are no errors in the specified project/branch, send the project resource files to the translation vendor.
* Alternative: translate
 
  +
* Alternative: <code>translate</code>
  +
 
==== Translation Status: ====
 
==== Translation Status: ====
* translation status <group>.<project>[:<branch>]
+
'''<code>translation status [-a] <group>.<project>[:<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: tran stat
+
* 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
* notify me <group>.<project>[:<branch>]
+
'''<code>notify me <group>.<project>[:<branch>]</code>'''
** Adds sender (user or room) to recipient list
+
* Adds sender (user or room) to recipient list
* notify who <group>.<project>[:<branch>]
+
'''<code>notify who <group>.<project>[:<branch>]</code>'''
** Displays recipient list
+
* Displays recipient list
* notify stop <group>.<project>[:<branch>]
+
'''<code>notify stop <group>.<project>[:<branch>]</code>'''
** Removes sender (user or room) from recipient list
+
* Removes sender (user or room) from recipient list
  +
 
=== Globalyzer Lite Only ===
 
=== Globalyzer Lite Only ===
 
==== I18n Scan: ====
 
==== I18n Scan: ====
* i18n scan <group>.<project>:<branch>
+
'''<code>i18n scan <group>.<project>:<branch></code>'''
* Scans differences between the branch and its parent for any i18n issues and displays a summary of the scan results.
+
* Scans the differences between the branch and its parent for any internationalization issues and displays a summary of the scan results.
   
  +
=== Batch ===
== LingoBot Command Breakdown ==
 
=== Universal ===
+
==== Create Batch project ====
  +
'''<code>add <project> to <batch></code>'''
=== LRM Only ===
 
  +
* Create the <batch> and add <project> to it
=== Globalyzer Lite Only ===
 
  +
  +
==== 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>'''
  +
* Pseudo-localizes the specified project and branches.
  +
  +
==== Prep Kit (Translate): ====
  +
'''<code>prep kit <group>.<project>:<branch1>:<branch2></code>'''
  +
* If there are no errors in the specified project/branch, sends the project to the translation vendor.
  +
* Alternative: <code>translate</code>
  +
  +
==== Translation Status: ====
  +
'''<code>translation status <group>.<project>:<branch1>:<branch2></code>'''
  +
  +
'''<code>translation status <batch></code>'''
  +
* Displays a summary of the current status of translations on the specified project/branch.
  +
* Shorthand: <code>tran stat</code>
  +
  +
==== 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 22:47, 19 December 2018

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.

Universal

Duplicate Project:

duplicate project[ --force] <group>.<project>:<branch>

  • 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: dup proj, -f

Delete Project:

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

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

Update Dashboard:

update dashboard <group>.<project>[:<branch>]

  • Updates the dashboard with the latest information from the specified project/branch.
  • Shorthand: up dash

Show Dashboard:

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

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

List Projects:

list projects[ <query>]

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

Ping:

ping

  • Replies with "PONG".
  • A way to test the LingoBot connectivity.

Cleanup:

cleanup

  • Deletes all projects whose branches no longer exist.

Help:

help[ <query>]

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

Status:

status

  • 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

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.

Prep Kit (Translate):

prep kit <group>.<project>:<branch>

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

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
  • 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: translation status <group_name>.<project_name>:<branch>|<locale1>|<locale2>

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

Globalyzer Lite Only

I18n Scan:

i18n scan <group>.<project>:<branch>

  • 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

add <project> to <batch>

  • Create the <batch> and add <project> to it

Duplicate Project:

duplicate project[ --force] <batch>:<branch>

  • 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: dup proj

Delete Project:

delete project <batch>

  • Delete the batch project, but leave the projects that were the components alone and in the list.
  • Shorthand: del proj

Update Dashboard:

update dashboard <batch>

  • Updates the dashboard with the latest information from all projects in the batch.
  • Shorthand: up dash

Show Dashboard:

show dashboard <batch>

  • Displays the URL of the dashboard corresponding all the projects in the batch.
  • Shorthand: show dash

List Projects:

list projects <batch>

  • Displays a list of all the projects in the batch.
  • Shorthand: list proj

Remove project from batch:

remove <project> from <batch>

  • Remove projects from a batch, but leave them in the list of projects.

LRM Only

Critical Errors:

show errors <group>.<project>:<branch1>:<branch2>

show errors <batch>

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

Pseudo-localize:

pseudoloc <group>.<project>:<branch1>:<branch2>

  • Pseudo-localizes the specified project and branches.

Prep Kit (Translate):

prep kit <group>.<project>:<branch1>:<branch2>

  • If there are no errors in the specified project/branch, sends the project to the translation vendor.
  • Alternative: translate

Translation Status:

translation status <group>.<project>:<branch1>:<branch2>

translation status <batch>

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

Globalyzer Lite Only

I18n Scan:

  • i18n scan <group>.<project>:<branch1>:<branch2> or i18n scan <batch>
  • Scans differences between the branch and its parent for any i18n issues and displays a summary of the scan results.