1--- 2title: Documenting CLDR Tools 3--- 4 5# Documenting CLDR Tools 6 7*Developers: Make sure your tool is easily accessible from the command line.* 8 9You can add the @CLDRTool annotation to any class in cldr\-code that has a main() function, and it will be documented as part of the JAR cldr\-code.jar is used. 10 11See [CLDR Tools](https://cldr.unicode.org/development/cldr-tools) for general information about obtaining and using CLDR tools. 12 13## Coding it 14 15An example from ConsoleCheckCLDR.java will start us out here 16 17  @CLDRTool(alias \= "check", 18 19  description \= "Run CheckCLDR against CLDR data") 20 21  public class ConsoleCheckCLDR { … 22 23Then, calling ```java -jar cldr-tools.jar -l``` produces: 24 25  *check \- Run CheckCLDR against CLDR data* 26 27  *\<http://cldr.unicode.org/tools/check\>* 28 29  *\= org.unicode.cldr.test.ConsoleCheckCLDR* 30 31And then ```java -jar cldr-tools.jar check``` can be used to run this tool. All additional arguments after "check" are passed to **ConsoleCheckCLDR.main()** as arguments. 32 33Note these annotation parameters. Only "alias" is required. 34 35- **alias** \- used from the command line instead of the full class name. Also forms part of the default URL for documentation. 36- **description** \- a short description of the tool. 37 38Additional parameters: 39 40- **url** \- you can specify a custom URL for the tool. This is displayed with the listing. 41- **hidden** \- if non\-empty, this specifies a reason to *not* show the tool when running "java \-jar" without "\-l". For example, the main() function may be a less\-useful internal tool, or a test. 42## Documenting it 43 44Assuming your tools’s alias is *myalias,* create a new subpage with the URL http://cldr.unicode.org/tools/myalias (a subpage of [CLDR Tools](https://cldr.unicode.org/development/cldr-tools)). Fill this page out with information about how to use your tool. 45 46