Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[skip-changelog] Add output.no_color to configuration docs #2246

Merged
merged 2 commits into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions configuration/configuration.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,16 @@
},
"type": "object"
},
"output": {
"description": "settings related to text output.",
"properties": {
"no_color": {
"description": "ANSI color escape codes are added by default to the output. Set to `true` to disable colored text output.",
"type": "boolean"
}
},
"type": "object"
},
"sketch": {
"description": "configuration options relating to [Arduino sketches][sketch specification].",
"properties": {
Expand Down
3 changes: 3 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
- `metrics` - settings related to the collection of data used for continued improvement of Arduino CLI.
- `addr` - TCP port used for metrics communication.
- `enabled` - controls the use of metrics.
- `output` - settings related to text output.
- `no_color` - ANSI color escape codes are added by default to the output. Set to `true` to disable colored text
output.
- `sketch` - configuration options relating to [Arduino sketches][sketch specification].
- `always_export_binaries` - set to `true` to make [`arduino-cli compile`][arduino-cli compile] always save binaries
to the sketch folder. This is the equivalent of using the [`--export-binaries`][arduino-cli compile options] flag.
Expand Down