|  | 
| --- |
| **This software is not currently supported by Amazon Mechanical Turk** The Amazon Mechanical Turk Command Line Tools (CLT) are not currently maintained by Amazon Mechanical Turk. If you would still like to use Amazon Mechanical Turk from the command line, use the `mturk` command in the AWS Command Line Interface (CLI). For more information, see the `mturk` section of the [ AWS CLI Command Reference ](https://docs.aws.amazon.com/cli/latest/reference/mturk/index.html).  | 

 

# makeTemplate
<a name="CLTReference_MakeTemplateCommand"></a>

## Description
<a name="w2aab9c46b2"></a>

 The `makeTemplate` command creates a copy of a sample application. After you run the sample applications that the Amazon Mechanical Turk Command Line Tools provide, you might want to create your own application, probably one that is similar to one of the sample applications. The `makeTemplate` command makes it easy for you to replicate one of the samples in a different directory. 

 You can make a template of a HIT-generating sample, such as the Hello World sample or the Best Image sample. For these templates, run the `makeTemplate` command from the `[Command Line Tools installation directory]\hits` directory. 

 You can also make templates of Qualification-generating samples, such as the Assign Qualification sample. For these templates, run the `makeTemplate` from the `Command Line Tools installation directory]\qualifications` directory. 

## Arguments
<a name="w2aab9c46b4"></a>

 The following table describes the arguments for the `makeTemplate` command. 


| Name | Description | Required | 
| --- | --- | --- | 
|  `-help` or `-h`  |  Displays the help for this operation. Example: `-help`  |  No  | 
|  `-os [Dos or Unix]`   |  The type of the operating system. Example: `-os Dos`  |  Yes  | 
|  `-sandbox`  |   Runs this command in the Amazon Mechanical Turk sandbox for testing. This argument takes precedence even if you specify the production web site in your mturk.properties file.   Example:`-sandbox`   |  No  | 
|  `-scriptTemplateDir [path]`  |  The relative path to the script directory.   Example:`-scriptTemplateDir ../etc/templates/hits`   |  Yes  | 
|  `-target [directory name]`  |   Specifies the name of the directory to create. This determines the directory where the new files will be copied. This name is also used for the files that are created in this directory.  Example: `-target weathersurvey`   |  Yes  | 
|  `-targetRootDir [path]`  |  The relative path to the root of the target directory.   Example:`-targetRootDir ../hits`   |  Yes  | 
|  `-template [directory name]`  |   The name of the sample directory you are making the template from.   Example:`-template image_category`   |  Yes  | 
|  `-templateRootDir [path]`  |  The relative path to the root of the template directory.   Example:`-templateRootDir ../samples `   |  Yes  | 
|  `-type [template type]`  |  The type of the template, Hit or Qual.   Example:`-type Hit `   |  Yes  | 

 When you run this command for HIT-type samples, the Command Line Tools creates the new directory and copies the `.input`, `.question`, and `.properties` files from the specified sample. It creates these files with the name specified in the `-target` option. The Command Line Tools also creates new `run.cmd`, `getResults.cmd`, and `approveAndDeleteResults.cmd` files. 

 When you run this command for qualification-type samples, the Command Line Tools creates the new directory and copies the `.answer`,`.question`, and `.properties` files from the specified sample. It creates these files with the name specified in the `-target` option. The Command Line Tools also creates new `createQualification.cmd`, `updateQualification.cmd`, and `deactivateQualification.cmd` files. 

## Example
<a name="w2aab9c46b6"></a>

 The following examples for Unix and Windows show how to use the `makeTemplate` command. 

### Unix
<a name="w2aab9c46b6b4"></a>

 The following example demonstrates how to call this command from Unix. 

```
./makeTemplate.sh -target my_survey -template best_image
```

### Windows
<a name="w2aab9c46b6b6"></a>

 The following example demonstrates how to call this command from Microsoft Windows. 

```
makeTemplate -template helloworld  -target newhelloworld3 -os Dos -type Hit -templateRootDir ..\samples -targetRootDir ..\hits -scriptTemplateDir ..\etc\templates\hits
```

## Output
<a name="w2aab9c46b8"></a>

These examples produce the following output.

```
Copying resource file: ..\hits\my_survey\my_survey.question
Copying resource file: ..\hits\my_survey\my_survey.properties
Copying resource file: ..\hits\my_survey\my_survey.input
Generating script: ..\hits\my_survey\run.cmd
Generating script: ..\hits\my_survey\getResults.cmd
Generating script: ..\hits\my_survey\approveAndDeleteResults.cmd
```