-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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
Create hotspot #37140
base: next
Are you sure you want to change the base?
Create hotspot #37140
Conversation
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the Home Assistant command-line interface (CLI) documentation by introducing new commands and expanding the help command output. The changes focus on adding more detailed instructions for core updates, network configuration, and providing a more comprehensive list of available commands. The documentation now includes specific syntax for updating Home Assistant to a precise version and creating a WiFi access point, enhancing user guidance for command-line interactions. Changes
Sequence DiagramsequenceDiagram
participant User
participant CLI as Home Assistant CLI
participant Core as Home Assistant Core
participant Network as Network Configuration
User->>CLI: ha core update --version x.y.z
CLI->>Core: Request specific version update
Core-->>CLI: Update confirmation
User->>CLI: ha network update
CLI->>Network: Configure WiFi access point
Network-->>CLI: Configuration status
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (3)
source/_includes/common-tasks/commandline.md (3)
Line range hint
47-57
: Add version compatibility warning.Consider adding a note about version compatibility to prevent users from accidentally downgrading or skipping major versions. This helps users avoid potential breaking changes or migration issues.
Add this warning after the example:
Replace x.y.z with the desired version like `--version {{current_version}}` + > **Important:** It's recommended to update only to the next available version to ensure compatibility. Skipping versions may lead to migration issues.
64-65
: Enhance band and channel documentation.The current description of band and channel options is incomplete and could be more informative.
Add more detailed information:
-band='bg' # for 2.4GHz, 'a' for 5GHz, more later with 802.11ax and 802.11be -channel=5 # typically 1-14 for 'bg', 32-177 for 'a' +band='bg' # Options: 'bg' (2.4GHz), 'a' (5GHz), 'ax' (WiFi 6), 'be' (WiFi 7, where supported) +channel=5 # Channel ranges: 1-14 (2.4GHz/'bg'), 36-165 (5GHz/'a'), check local regulations
87-112
: Consider grouping related commands in the help output.The command list would be more user-friendly if organized into logical groups with headers.
Consider reorganizing the commands into categories like:
Available Commands: System Management: core Provides control of the Home Assistant Core supervisor Monitor, control and configure the Home Assistant Supervisor host Control the host/system that Home Assistant is running on Network & Security: network Network specific for updating, info and configuration imports dns Get information, update or configure the Home Assistant DNS server security Get information and manage security functionality Updates & Maintenance: available-updates Provides information about current pending updates refresh-updates Reload stores and version information backups Create, restore and remove backups [Additional categories...]
1f23064
to
c1c7e48
Compare
14bdf43
to
316c104
Compare
i built HAOS with changes from home-assistant/supervisor#5577 and home-assistant/cli#533 and was able to actually test this on rpi4b. the command worked with one small tweak so i fixed, squashed my commits, and rebased next. i will hold this |
513099a
to
a6c7774
Compare
a6c7774
to
833d90a
Compare
requires home-assistant/operating-system#3865 |
Proposed change
document changes proposed in home-assistant/cli#533 to create an access point
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit
Documentation
New Features