[cli] Document --no-defaults and --show-secrets for esphome config#6716
Open
jesserockz wants to merge 1 commit into
Open
[cli] Document --no-defaults and --show-secrets for esphome config#6716jesserockz wants to merge 1 commit into
jesserockz wants to merge 1 commit into
Conversation
…onfig Adds an Options section under the config command listing both flags; --show-secrets was previously undocumented as well. Matches esphome/esphome#16718.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the ESPHome CLI documentation to cover two esphome config flags (--no-defaults and --show-secrets) so users can better control config output for sharing, diffing, and debugging.
Changes:
- Added a new
#### Optionssubsection under theconfigcommand. - Documented
--show-secrets(previously undocumented) and--no-defaults(new flag from esphome/esphome#16718).
| #### Options | ||
|
|
||
| **`--show-secrets`** | ||
| : Show secret values in the output instead of redacting them. |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
18 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents the new
--no-defaultsflag onesphome config(added in esphome/esphome#16718) and, while at it, the previously-undocumented--show-secretsflag. Both are listed under a new#### Optionssection inguides/cli.mdx.--no-defaultsmakesesphome configemit only the keys the user wrote in YAML, skipping the values that schema validation fills in from defaults. Substitutions, packages, and!extend/!removeare still resolved so the output remains a faithful "user YAML" view.Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/src/content/docs/components/index.mdxwhen creating new documents for new components or cookbook.