Skip to content

Commit 4e66850

Browse files
author
Pete Bishop
committed
Configuration docs
1 parent 0969ef7 commit 4e66850

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

Writerside/n.tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
<toc-element topic="self-update.md"/>
2020
<toc-element topic="update.md"/>
2121
</toc-element>
22+
<toc-element topic="Configuration.md"/>
2223
<toc-element topic="Contributing.md"/>
2324
<toc-element topic="Sponsoring.md"/>
2425
<toc-element topic="Tool-Resources.md" hidden="true"/>

Writerside/topics/Configuration.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Configuration
2+
3+
<tip>
4+
Configuration is available from version 1.0.3.
5+
</tip>
6+
7+
NativeCLI provides a way to configure certain behaviours within the application.
8+
9+
You are able to configure both a global configuration and a local, project-specific configuration.
10+
11+
## Global Configuration
12+
13+
## Command
14+
15+
Syntax:
16+
17+
```shell
18+
nativecli config --global [KEY] [VALUE]
19+
```
20+
21+
## Local Configuration
22+
23+
Syntax:
24+
25+
```shell
26+
nativecli config [KEY] [VALUE]
27+
```
28+
29+
<tip>
30+
Note the only difference is the `--global` flag.
31+
</tip>
32+
33+
## Options
34+
35+
Describe what each option is used for:
36+
37+
-g, --global
38+
: Sets a global configuration option. This will affect all projects where a local configuration has not overridden it.
39+
40+
## Available Configuration Options
41+
updates.check
42+
: This option controls whether NativeCLI will check for updates when it is run. The default is `true`.
43+
44+
updates.auto
45+
: This option controls whether NativeCLI will automatically update itself when a new version is available. The default is `false`.
46+
47+
## Examples
48+
49+
Set the global configuration option `updates.check` to `false`:
50+
51+
```shell
52+
nativecli config --global updates.check false
53+
```

0 commit comments

Comments
 (0)