Skip to content

Commit cfaa1a8

Browse files
committed
Merge pull request #1353 from NativeScript/vladimirov/help-for-template-option
Add help for --template option
2 parents 637746a + 79d383f commit cfaa1a8

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/man_pages/project/creation/create.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,31 @@ create
33

44
Usage | Synopsis
55
---|---
6-
General | `$ tns create <App Name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]`
6+
Create from default JavaScript template | `$ tns create <App Name> [--path <Directory>] [--appid <App ID>]`
7+
Create from default TypeScript template | `$ tns create <App Name> [--path <Directory>] [--appid <App ID> --template typescript` OR `$ tns create <App Name> [--path <Directory>] [--appid <App ID> --template tsc`
8+
Copy from existing project | `$ tns create <App Name> [--path <Directory>] [--appid <App ID>] --copy-from <Directory>`
9+
Create from custom template | `$ tns create <App Name> [--path <Directory>] [--appid <App ID>] --template <Template>`
710

8-
Creates a new project for native development with NativeScript from the default template or from an existing NativeScript project.
11+
Creates a new project for native development with NativeScript.
912

1013
### Options
1114
* `--path` - Specifies the directory where you want to create the project, if different from the current directory. The directory must be empty.
12-
* `--appid` - Sets the application identifier for your project.
13-
* `--copy-from` - Specifies a directory which contains an existing NativeScript project. If not set, the NativeScript CLI creates the project from the default hello-world template.
15+
* `--appid` - Sets the application identifier for your project.
16+
* `--copy-from` - Specifies a directory which contains an existing NativeScript project. If `--copy-from` and `--template` are not set, the NativeScript CLI creates the project from the default JavaScript hello-world template.
17+
* `--template` - Specifies a valid na in the default hello-world template.<% } %>
1418

1519
### Attributes
16-
* `<App Name>` is the name of project. The specified name must meet the requirements of all platforms that you want to target. <% if(isConsole) { %>For more information about the `<App Name>` requirements, run `$ tns help create`<% } %><% if(isHtml) { %>For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores. The name must start with a letter.
17-
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens.<% } %>
18-
* `<App ID>` is the application identifier for your project. It must be a domain name in reverse and must meet the requirements of all platforms that you want to target. If not specified, the application identifier is set to `org.nativescript.<App name>` <% if(isConsole) { %>For more information about the `<App ID>` requirements, run `$ tns help create`<% } %><% if(isHtml) { %>For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores in the strings of the reversed domain name, separated by a dot. Strings must be separated by a dot and must start with a letter. For example: `com.nativescript.My_Andro1d_App`
19-
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens in the strings of the reversed domain name. Strings must be separated by a dot. For example: `com.nativescript.My-i0s-App`.<% } %>
20+
* `<App Name>` is the name of project. The specified name must meet the requirements of all platforms that you want to target. <% if(isConsole) { %>For more information about the `<App Name>` requirements, run `$ tns help create`<% } %><% if(isHtml) { %>For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores. The name must start with a letter.
21+
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens.<% } %>
22+
* `<App ID>` is the application identifier for your project. It must be a domain name in reverse and must meet the requirements of all platforms that you want to target. If not specified, the application identifier is set to `org.nativescript.<App name>` <% if(isConsole) { %>For more information about the `<App ID>` requirements, run `$ tns help create`<% } %><% if(isHtml) { %>For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores in the strings of the reversed domain name, separated by a dot. Strings must be separated by a dot and must start with a letter. For example: `com.nativescript.My_Andro1d_App`
23+
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens in the strings of the reversed domain name. Strings must be separated by a dot. For example: `com.nativescript.My-i0s-App`.
24+
* `<Template>` is a valid npm package which you want to use as template for your app. You can specify the package by name in the npm registry or by local path or GitHub URL to a directory or .tar.gz containing a package.json file. The contents of the package will be copied to the `app` directory of your project.<% } %>
2025

21-
<% if(isHtml) { %>
26+
<% if(isHtml) { %>
2227
### Related Commands
2328

2429
Command | Description
2530
----------|----------
2631
[init](init.html) | Initializes a project for development. The command prompts you to provide your project configuration interactively and uses the information to create a new package.json file or update the existing one.
2732
[install](/lib-management/install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
28-
<% } %>
33+
<% } %>

0 commit comments

Comments
 (0)