You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -95,12 +95,12 @@ When the patch is reviewed and merged, you can safely delete your branch and pul
95
95
Updating the CLI Documentation
96
96
===
97
97
98
-
The CLI documentation is what you see when running the `tns help` command.
98
+
The CLI documentation is what you see when running the `ns help` command.
99
99
This documentation is distributed as part of the CLI package and is generated from the *.md files that can be found in <ahref="https://github.com/NativeScript/nativescript-cli/tree/master/docs/man_pages"target="_blank">man_pages folder</a>
100
100
The output of the documentation is html static pages that are generated on post install hook of the CLI installation.
101
101
In addition, documentation generation is triggered every time there is no html article for the respective help command that is executed.
102
102
103
-
In order to see a change applied in your development workspace after editing the *.md files, you can use the `tns dev-generate-help` command.
103
+
In order to see a change applied in your development workspace after editing the *.md files, you can use the `ns dev-generate-help` command.
104
104
This will trigger regeneration of all html files on your local environment. Mind that you need to run from the /bin folder of the nativescript_cli.
> NOTE: In several cases CLI passes additional configuration properties in the `context` of the `loggingEvent`. Full list is available in the `tns.constants.LoggerConfigData` object. These properties are used by CLI's layout and appender to change the way the message is printed on the terminal and if it should be on stderr or stdout.
1658
+
> NOTE: In several cases CLI passes additional configuration properties in the `context` of the `loggingEvent`. Full list is available in the `ns.constants.LoggerConfigData` object. These properties are used by CLI's layout and appender to change the way the message is printed on the terminal and if it should be on stderr or stdout.
1659
1659
1660
1660
#### cli-appender
1661
1661
`cli-appender` prints messages to stdout or stderr based on the passed options for the message.
To check if your system is configured properly, run the following command.
107
107
108
108
```Shell
109
-
tns doctor
109
+
ns doctor
110
110
```
111
111
112
112
## Configure Proxy Settings
@@ -116,7 +116,7 @@ If you are working with the NativeScript CLI behind a web proxy, you need to con
116
116
### Set Proxy Settings
117
117
118
118
```Shell
119
-
tns proxy set<Url><Username><Password>
119
+
ns proxy set<Url><Username><Password>
120
120
```
121
121
122
122
#### Attributes
@@ -143,13 +143,13 @@ The <code>--insecure</code> flag allows you to perform insecure SSL connections
143
143
### Display Current Proxy Settings
144
144
145
145
```Shell
146
-
tns proxy
146
+
ns proxy
147
147
```
148
148
149
149
### Clear Proxy Settings
150
150
151
151
```Shell
152
-
tns proxy clear
152
+
ns proxy clear
153
153
```
154
154
155
155
[Back to Top][1]
@@ -165,7 +165,7 @@ Quick Start
165
165
166
166
## The Commands
167
167
168
-
Run `tns help` to view all available commands in the browser. Run `tns help <Command>` to view more information about a selected command in the browser. `tns --help` opens console help, where help information is shown in the console.
168
+
Run `ns help` to view all available commands in the browser. Run `ns help <Command>` to view more information about a selected command in the browser. `ns --help` opens console help, where help information is shown in the console.
169
169
170
170
[Back to Top][1]
171
171
@@ -174,28 +174,28 @@ Run `tns help` to view all available commands in the browser. Run `tns help <Com
174
174
To create a new cross-platform project from the default JavaScript template, run the following command.
175
175
176
176
```Shell
177
-
tns create MyApp --js
177
+
ns create MyApp --js
178
178
```
179
179
180
180
To create a new cross-platform project from the default TypeScript, Angular or Vue template, use the `template` option followed by either `typescript`, `angular` or `vue`.
181
181
182
182
```Shell
183
-
tns create MyApp --template typescript
184
-
tns create MyApp --template angular
185
-
tns create MyApp --template vue
183
+
ns create MyApp --template typescript
184
+
ns create MyApp --template angular
185
+
ns create MyApp --template vue
186
186
```
187
187
188
188
Or you can simply use the shorthand `tsc` and `ng` options.
189
189
190
190
```Shell
191
-
tns create MyApp --tsc
192
-
tns create MyApp --ng
191
+
ns create MyApp --tsc
192
+
ns create MyApp --ng
193
193
```
194
194
With the `template` option you can also specify a local or a remote path to the template that you want to use to create your project.
195
195
For example, if you want to create a React template, run the following command.
The NativeScript CLI creates a new project and sets the application identifier to `org.nativescript.myapp`.
@@ -258,8 +258,8 @@ You can always override the generated entitlements file, by pointing to your own
258
258
You can build it for your target mobile platforms.
259
259
260
260
```Shell
261
-
tns build android
262
-
tns build ios
261
+
ns build android
262
+
ns build ios
263
263
```
264
264
265
265
The NativeScript CLI calls the SDK for the selected target platform and uses it to build your app locally.
@@ -277,16 +277,16 @@ You can test your work in progress on connected Android or iOS devices.
277
277
To verify that the NativeScript CLI recognizes your connected devices, run the following command.
278
278
279
279
```Shell
280
-
tns devices
280
+
ns devices
281
281
```
282
282
283
283
The NativeScript CLI lists all connected physical devices and running emulators/simulators.
284
284
285
285
After you have listed the available devices, you can quickly run your app on connected devices by executing:
286
286
287
287
```Shell
288
-
tns run android
289
-
tns run ios
288
+
ns run android
289
+
ns run ios
290
290
```
291
291
292
292
[Back to Top][1]
@@ -296,7 +296,7 @@ Extending the CLI
296
296
297
297
The NativeScript CLI lets you extend its behavior and customize it to fit your needs by using [hooks](https://en.wikipedia.org/wiki/Hooking).
298
298
299
-
When you run one of the extendable commands (for example, `tns build`), the CLI checks for hooks and executes them. Plugins can also use hooks to control the compilation of the application package.
299
+
When you run one of the extendable commands (for example, `ns build`), the CLI checks for hooks and executes them. Plugins can also use hooks to control the compilation of the application package.
300
300
301
301
For more information, see the [Extending the CLI document](https://github.com/NativeScript/nativescript-cli/blob/master/extending-cli.md)
302
302
@@ -308,7 +308,7 @@ Troubleshooting
308
308
If the NativeScript CLI does not behave as expected, you might be facing a configuration issue. For example, a missing `JAVA` path. To check if your system is configured properly for the NativeScript CLI, run the following command.
309
309
310
310
```bash
311
-
tns doctor
311
+
ns doctor
312
312
```
313
313
314
314
This command prints warnings about current configuration issues and provides basic information about how to resolve them.
@@ -337,7 +337,7 @@ npm run setup
337
337
```
338
338
339
339
To use the locally built CLI instead `tns` you can call `PATH_TO_CLI_FOLDER/bin/tns`. For example:
Copy file name to clipboardexpand all lines: extending-cli.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ Extending the CLI
3
3
4
4
The NativeScript CLI lets you extend its behavior and customize it to fit your needs by using [hooks](https://en.wikipedia.org/wiki/Hooking).
5
5
6
-
When you run one of the [extendable commands](#commands-with-hooking-support) (for example, `tns build`), the CLI checks for hooks and executes them. Plugins can also use hooks to control the compilation of the application package.
6
+
When you run one of the [extendable commands](#commands-with-hooking-support) (for example, `ns build`), the CLI checks for hooks and executes them. Plugins can also use hooks to control the compilation of the application package.
7
7
8
8
## Hooks in the NativeScript CLI
9
9
@@ -105,14 +105,14 @@ The only two operations to which you can attach hooks are `prepare` operations a
105
105
106
106
The NativeScriot CLI executes hooks attached to `prepare` when you run the following commands:
107
107
108
-
* `tns prepare <Platform>`
109
-
* `tns build <Platform>`
110
-
* `tns deploy <Platform>`
111
-
* `tns run <Platform>`
112
-
* `tns livesync <Platform>`
113
-
* `tns test <Platform>`
108
+
* `ns prepare <Platform>`
109
+
* `ns build <Platform>`
110
+
* `ns deploy <Platform>`
111
+
* `ns run <Platform>`
112
+
* `ns livesync <Platform>`
113
+
* `ns test <Platform>`
114
114
115
115
The NativeScriot CLI executes hooks attached to `--watch` operations when you run the following commands:
116
116
117
-
* `tns test <Platform>` with the `--watch` option.
118
-
* `tns livesync <Platform>` with the `--watch` option.
117
+
* `ns test <Platform>` with the `--watch` option.
118
+
* `ns livesync <Platform>` with the `--watch` option.
0 commit comments