Move flags after the command

[nblock]

The built-in help also shows flags to given after the command. Align documentation examples accordingly.

• have read the CONTRIBUTING.md file
• raised a GitHub issue or discussed it on the projects chat beforehand
• added unit tests
• added integration tests
• updated documentation if needed
• updated CHANGELOG.md

Summary by CodeRabbit

• Documentation
  • Simplified command syntax for registering machines and creating pre-authenticated keys in the headscale documentation, enhancing clarity and usability.
  • Removed redundant headscale prefix in command examples, aligning with common command-line conventions.

[coderabbitai]

Walkthrough

The documentation for the headscale command-line tool has been updated to simplify command syntax by removing the redundant headscale prefix and repositioning the --user flag. This change applies to commands for registering machines and creating pre-authenticated keys, enhancing clarity and usability while retaining the original functionality.

Changes

Files	Change Summary
docs/running-headscale-container.md	Updated command syntax for registering a machine and creating pre-authenticated keys.
docs/running-headscale-linux-manual.md	Streamlined command examples by removing redundant prefixes and repositioning flags.
docs/running-headscale-linux.md	Simplified command structure for registering machines and generating pre-authenticated keys.
docs/running-headscale-openbsd.md	Modified command syntax for node registration and key creation, enhancing clarity.
docs/running-headscale-sealos.md	Adjusted command structure for user specification, maintaining original functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Headscale

    User->>Headscale: Register Node
    Headscale-->>User: Confirmation

    User->>Headscale: Create Pre-authenticated Key
    Headscale-->>User: Key Created

Loading

🐇 In the meadow, I hop with glee,
Commands now flow so easily!
With a tweak here and a change there,
Headscale's syntax is light as air!
Hopping through tasks, I dance and play,
Celebrating the changes, hip-hip-hooray! 🌼

---

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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f039caf and 954a0a7.

Files selected for processing (5)

• docs/running-headscale-container.md (2 hunks)
• docs/running-headscale-linux-manual.md (1 hunks)
• docs/running-headscale-linux.md (1 hunks)
• docs/running-headscale-openbsd.md (1 hunks)
• docs/running-headscale-sealos.md (1 hunks)

Files skipped from review due to trivial changes (1)

• docs/running-headscale-container.md

Additional context used

Markdownlint

docs/running-headscale-sealos.md

51-51: Expected: indented; Actual: fenced
Code block style

(MD046, code-block-style)

docs/running-headscale-openbsd.md

139-139: Expected: indented; Actual: fenced
Code block style

(MD046, code-block-style)

docs/running-headscale-linux-manual.md

102-102: Expected: indented; Actual: fenced
Code block style

(MD046, code-block-style)

Additional comments not posted (8)

docs/running-headscale-linux.md (2)

81-81: LGTM!

The change to the command syntax for registering a machine looks good. Moving the --user flag after the nodes register command aligns the syntax with the built-in help feature and improves clarity.

---

89-89: LGTM!

The change to the command syntax for generating a pre-authenticated key looks good. Moving the --user flag after the preauthkeys create command aligns the syntax with the built-in help feature and improves clarity.

docs/running-headscale-sealos.md (2)

44-44: LGTM!

The code changes are approved. The updated command syntax simplifies the command and improves clarity by removing the redundant headscale prefix and repositioning the --user flag after the command. This change aligns the documentation examples with the built-in help.

---

52-52: LGTM!

The code changes are approved. The updated command syntax simplifies the command and improves clarity by removing the redundant headscale prefix and repositioning the --user flag after the command. This change aligns the documentation examples with the built-in help.

docs/running-headscale-openbsd.md (2)

132-132: LGTM!

The change to the command syntax for registering a machine looks good. Moving the --user flag after the nodes register subcommand aligns with the project's built-in help feature and improves clarity. The functionality remains intact.

---

140-140: Looks good!

Moving the --user flag after the preauthkeys create subcommand is consistent with the project's built-in help feature and enhances the clarity of the command. The functionality is preserved.

docs/running-headscale-linux-manual.md (2)

95-95: The change to the command for registering a machine looks good.

Removing the redundant headscale prefix and repositioning the --user flag simplifies the command syntax and improves the clarity of the documentation without altering the functionality.

---

103-103: The change to the command for generating a pre-authenticated key looks good.

Removing the redundant headscale prefix and repositioning the --user flag simplifies the command syntax and improves the clarity of the documentation without altering the functionality.

[kradalby]

neat!