LRM Commands Reference - Revision history

Llawson: /* Reset a project */

2022-04-29T16:49:29Z

Reset a project

← Older revision		Revision as of 16:49, 29 April 2022
Line 255:		Line 255:

	This will result as a prompt to verify that resetting the project is expected. This command cannot be used in a script.		This will result as a prompt to verify that resetting the project is expected. This command cannot be used in a script.

			==== Remove ghost keys ====
			This command will remove all the ''ghost keys'' from all the localized files. A ''ghost key'' is a key that exists only in the localized file but not in the base resource file. The removal of ghost keys automatically occurs during the import process but there may be legacy files that will never be prepped and imported. This is where the ''remove ghost keys'' command comes in handy.

			'''lrm --remove-ghost-keys --project-name <project> --group-name <group-name>'''

	==== Update a project ====		==== Update a project ====

Llawson: /* Reset a project */

2022-04-29T16:41:46Z

Reset a project

← Older revision		Revision as of 16:41, 29 April 2022
Line 252:		Line 252:

	'''lrm --reset-project --project-name <project> --group-name <group-name>'''		'''lrm --reset-project --project-name <project> --group-name <group-name>'''


			This will result as a prompt to verify that resetting the project is expected. This command cannot be used in a script.

	==== Update a project ====		==== Update a project ====

Llawson: /* Reset a project */

2022-04-29T16:40:47Z

Reset a project

← Older revision		Revision as of 16:40, 29 April 2022
Line 251:		Line 251:
	Sometimes, your project can get out-of-sync with your repo. One of the reasons that this can occur is if your repo structure is changed while there are outstanding prep kits. If it's not possible to deactivate the prep kit then the only choice may be to reset the project. This will delete the project in the database and recreate it without compromising the next prep kit version. If, for example, your next prep kit version is 111, then after resetting the project the next prep kit version will be 111. When you reset the project, any previous changes in text (as opposed to new keys) '''will''' not be detected as there is no longer a 'before' snapshot of the file before any changes occurred.		Sometimes, your project can get out-of-sync with your repo. One of the reasons that this can occur is if your repo structure is changed while there are outstanding prep kits. If it's not possible to deactivate the prep kit then the only choice may be to reset the project. This will delete the project in the database and recreate it without compromising the next prep kit version. If, for example, your next prep kit version is 111, then after resetting the project the next prep kit version will be 111. When you reset the project, any previous changes in text (as opposed to new keys) '''will''' not be detected as there is no longer a 'before' snapshot of the file before any changes occurred.

			'''lrm --reset-project --project-name <project> --group-name <group-name>'''

	==== Update a project ====		==== Update a project ====

Llawson: /* Update a project */

2022-04-29T16:39:07Z

Update a project

← Older revision		Revision as of 16:39, 29 April 2022
Line 246:		Line 246:
	or		or
	lrm -ep -pn MyProject -f /var/tmp -gn Blue		lrm -ep -pn MyProject -f /var/tmp -gn Blue


			==== Reset a project ====
			Sometimes, your project can get out-of-sync with your repo. One of the reasons that this can occur is if your repo structure is changed while there are outstanding prep kits. If it's not possible to deactivate the prep kit then the only choice may be to reset the project. This will delete the project in the database and recreate it without compromising the next prep kit version. If, for example, your next prep kit version is 111, then after resetting the project the next prep kit version will be 111. When you reset the project, any previous changes in text (as opposed to new keys) '''will''' not be detected as there is no longer a 'before' snapshot of the file before any changes occurred.

Llawson: /* Reference */

2022-04-29T16:32:47Z

Reference

Show changes

Olibouban at 20:28, 23 February 2021

2021-02-23T20:28:12Z

Show changes

Llawson: /* Transform Files */

2019-11-04T22:16:06Z

Transform Files

← Older revision		Revision as of 22:16, 4 November 2019
Line 317:		Line 317:

	This command can be called from the project's Jenkins Automation Job by adding the [[Quick_On-Boarding_Reference#Pseudo-Localize_Build_Step_.28Optional.29\|Pseudo-Localize]] build step.		This command can be called from the project's Jenkins Automation Job by adding the [[Quick_On-Boarding_Reference#Pseudo-Localize_Build_Step_.28Optional.29\|Pseudo-Localize]] build step.

	~~<! -- ==== Create Trackback files ====~~
	~~A trackback file is created from a base resource file. These are special resource files that are used to help developers and/or technical linguists identify the file or the key for that text.~~

	~~The locale for the trackback file is defined in the LRM project. A typical trackback is ''br'' for ''Breton'' See [[Supported_Resource_Bundles#Locales\| Project Locales]].~~

	The information that is stored in the trackback file defaults to ''key\|filename''. This information is configurable. See [[Group_Configuration_Files#config_lrm_info.properties\|config_lrm_info.properties]] for more information.

	~~'''Example Files '''~~

	~~<span style="background:#eaecf0">~~
	~~exampleFile.properties (Base Resource File)~~
	~~key1=This is the value for key1~~
	~~key2=This is the value for key2~~

	~~exampleFile_br.properties (Trackback file)~~
	~~key1=key1\|exampleFile.properties~~
	~~key2=key2\|exampleFile.properties~~
	~~</span>~~

	~~'''Command '''~~

	~~The command to create trackback files is:~~
	~~<span style="background:#eaecf0">~~
	~~java -jar lrm-cli.jar -tb -pn -gn~~
	~~:: or~~
	~~java -jar lrm-cli.jar --track-back -pn -gn~~
	~~</span> -->~~

	==== Create Instrumented files ====		==== Create Instrumented files ====

Llawson: /* Create Trackback files */

2019-11-04T22:12:48Z

Create Trackback files

← Older revision		Revision as of 22:12, 4 November 2019
Line 318:		Line 318:
	This command can be called from the project's Jenkins Automation Job by adding the [[Quick_On-Boarding_Reference#Pseudo-Localize_Build_Step_.28Optional.29\|Pseudo-Localize]] build step.		This command can be called from the project's Jenkins Automation Job by adding the [[Quick_On-Boarding_Reference#Pseudo-Localize_Build_Step_.28Optional.29\|Pseudo-Localize]] build step.

	==== Create Trackback files ====		<! -- ==== Create Trackback files ====
	A trackback file is created from a base resource file. These are special resource files that are used to help developers and/or technical linguists identify the file or the key for that text.		A trackback file is created from a base resource file. These are special resource files that are used to help developers and/or technical linguists identify the file or the key for that text.

Line 344:		Line 344:
	:: or		:: or
	java -jar lrm-cli.jar --track-back -pn -gn		java -jar lrm-cli.jar --track-back -pn -gn
	</span>		</span> -->

	==== Create Instrumented files ====		==== Create Instrumented files ====

Llawson: /* Reference */

2019-11-04T22:09:14Z

Reference

← Older revision		Revision as of 22:09, 4 November 2019
Line 149:		Line 149:
	supplied project name. Example:		supplied project name. Example:
	lrm-cli.jar -r -si -pn MyProjectName		lrm-cli.jar -r -si -pn MyProjectName
	~~-tb,--track-back Create `Track Back` files for a~~
	~~project. Example: lrm-cli.jar -tb~~
	~~--project-name MyProject --group-name~~
	~~MyGroup~~
	-ul,--update-license Update a group/company license.		-ul,--update-license Update a group/company license.
	Example: lrm-cli.jar -ul -gn		Example: lrm-cli.jar -ul -gn

Masnes: /* Create a project baseline */

2019-06-21T18:42:46Z

Create a project baseline

← Older revision		Revision as of 18:42, 21 June 2019
Line 309:		Line 309:
	Example:		Example:
	lrm -cb -pn MyProject -gn MyGroup		lrm -cb -pn MyProject -gn MyGroup

			Baselines will also be created prior to sending each prep kit.

	=== Transform Files ===		=== Transform Files ===