Update documentation for dashboard command

[vamega]

Document previously undocumented options --address and --socket

Description:

Related issue (if applicable): N/A

Pull request in esphome with YAML changes (if applicable): N/A

Checklist:

• I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
  or

• I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

• Link added in /index.rst when creating new documents for new components or cookbook.

[coderabbitai]

Walkthrough

The recent updates to the esphome dashboard command introduce three new options: --address, --socket, and a modified --open-ui behavior. The --address option allows users to set the bind address, while --socket enables manual setting of a Unix socket. Notably, the --open-ui option is now incompatible with --socket, ensuring users can't open the UI when using a Unix socket.

Changes

File	Change Summary
guides/cli.rst	Introduced new options --address, --socket, and modified the behavior of --open-ui option

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant CLI
    participant Dashboard

    User->>CLI: Run `esphome dashboard --address <address>`
    CLI->>Dashboard: Start dashboard with specified bind address
    Dashboard-->>CLI: Dashboard running at <address>

    User->>CLI: Run `esphome dashboard --socket <socket>`
    CLI->>Dashboard: Start dashboard with specified Unix socket
    Dashboard-->>CLI: Dashboard running at <socket>

    User->>CLI: Run `esphome dashboard --open-ui --socket <socket>`
    CLI-->>User: Error: `--open-ui` cannot be used with `--socket`

Loading

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	1dce227
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/666ccf32a5415200089a37f3
😎 Deploy Preview	https://deploy-preview-3923--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[vamega]

The rendered docs look good to me. Is there anything else I need to do to get this merged?
I'd like to merge this since I want to make a different contribution that will depend on this change.