Skip to content

Commit 036ffb2

Browse files
committed
fix: add config to help menu
1 parent 4e51f4c commit 036ffb2

File tree

4 files changed

+116
-1
lines changed

4 files changed

+116
-1
lines changed

docs/build-jekyll-md.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ set -e
44
rm -rf docs-cli
55
npm install --ignore-scripts
66

7-
grunt docs-jekyll
7+
npx grunt docs-jekyll
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<% if (isJekyll) { %>---
2+
title: ns config get
3+
position: 1
4+
---<% } %>
5+
6+
# ns config get
7+
8+
### Description
9+
10+
Prints the value for a specific key from the project's NativeScript configuration.
11+
12+
### Commands
13+
14+
Usage | Synopsis
15+
------|-------
16+
General | `$ ns config get <key>`
17+
18+
### Arguments
19+
20+
* `<key>` — The configuration key in dot-notation. Examples: `ios.id`, `android.codeCache`, `bundler`.
21+
22+
### Examples
23+
24+
* `$ ns config get ios.id`
25+
* `$ ns config get android.codeCache`
26+
* `$ ns config get bundler`
27+
28+
<% if(isHtml) { %>
29+
30+
### Related Commands
31+
32+
Command | Description
33+
----------|----------
34+
[config](config.html) | Lists all configuration values for the current project.
35+
[config set](config-set.html) | Sets the value for the specified configuration key.
36+
<% } %>
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<% if (isJekyll) { %>---
2+
title: ns config set
3+
position: 1
4+
---<% } %>
5+
6+
# ns config set
7+
8+
### Description
9+
10+
Sets the value for a specific key in the project's NativeScript configuration.
11+
12+
### Commands
13+
14+
Usage | Synopsis
15+
------|-------
16+
General | `$ ns config set <key> <value>`
17+
18+
### Arguments
19+
20+
* `<key>` — The configuration key in dot-notation. Examples: `ios.id`, `android.codeCache`, `bundler`.
21+
* `<value>` — The value to set. Parsed as JSON when possible (e.g. `true`, `42`, `{ "foo": "bar" }`). Otherwise treated as a string.
22+
23+
### Examples
24+
25+
* `$ ns config set ios.id org.nativescript.myapp`
26+
* `$ ns config set android.codeCache true`
27+
* `$ ns config set bundler vite`
28+
29+
### Notes
30+
31+
* Setting whole objects is not supported. Update individual keys instead. For example, use:
32+
`$ ns config set android.codeCache true`
33+
34+
### Related Commands
35+
36+
Command | Description
37+
----------|----------
38+
[config](config.html) | Lists all configuration values for the current project.
39+
[config get](config-get.html) | Prints the value for the specified configuration key.
40+
<% } %>

docs/man_pages/config/config.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<% if (isJekyll) { %>---
2+
title: ns config
3+
position: 6
4+
---<% } %>
5+
6+
# ns config
7+
8+
### Description
9+
10+
View and manage your project's NativeScript configuration stored in `nativescript.config.(js|ts)` (or legacy `nsconfig.json`).
11+
12+
### Commands
13+
14+
Usage | Synopsis
15+
------|---------
16+
List all config | `$ ns config`
17+
Get a value | `$ ns config get <key>`
18+
Set a value | `$ ns config set <key> <value>`
19+
20+
### Examples
21+
22+
* `$ ns config` — prints all configuration values.
23+
* `$ ns config get ios.id` — prints the iOS bundle identifier.
24+
* `$ ns config set android.codeCache true` — enables Android V8 code cache.
25+
26+
### Notes
27+
28+
* Keys use dot-notation, for example: `ios.id`, `android.codeCache`, `bundler`.
29+
* Values are parsed as JSON when possible. Use quotes for strings with spaces.
30+
31+
<% if(isHtml) { %>
32+
33+
### Related Commands
34+
35+
Command | Description
36+
----------|----------
37+
[config get](config-get.html) | Prints the value for the specified configuration key.
38+
[config set](config-set.html) | Sets the value for the specified configuration key.
39+
<% } %>

0 commit comments

Comments
 (0)