[docs] place command after global options

[capcom6]

Summary by CodeRabbit

• Documentation
  • Updated usage instructions to reflect the new CLI invocation format, placing credentials before the subcommand (e.g., include username and password flags ahead of “send”).
  • Clarified the example to match current behavior while keeping the rest of the flow unchanged.

[github-actions]

🤖 Pull request artifacts

Platform	File
🍎 Darwin arm64	smsgate_Darwin_arm64.tar.gz
🍎 Darwin x86_64	smsgate_Darwin_x86_64.tar.gz
🐳 Docker	GitHub Container Registry
🐧 Linux arm64	smsgate_Linux_arm64.tar.gz
🐧 Linux i386	smsgate_Linux_i386.tar.gz
🐧 Linux x86_64	smsgate_Linux_x86_64.tar.gz
🪟 Windows arm64	smsgate_Windows_arm64.zip
🪟 Windows i386	smsgate_Windows_i386.zip
🪟 Windows x86_64	smsgate_Windows_x86_64.zip

[coderabbitai]

Walkthrough

README updated to modify the CLI usage example: credentials now precede the subcommand, changing from "smsgate send ..." to "smsgate -u -p send ...". No code or public API changes.

Changes

Cohort / File(s)	Summary of changes
Docs README.md	Updated CLI invocation in usage example to place credentials before the send subcommand: smsgate -u <username> -p <password> send ....

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• [docs] update README #24 — Also updates README usage examples for CLI credential passing and invocation format.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "[docs] place command after global options" succinctly and accurately summarizes the primary change in the PR — updating documentation to show the subcommand placed after global CLI options (matching the README usage example change). It is concise, specific, and clearly related to the changeset, making it easy for teammates to understand the main intent at a glance.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/fix-command-position

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

94-96: Inconsistent flag: --phone vs --phones.

Other examples use --phones; Docker snippet uses --phone. Unify to --phones for consistency.

Apply:

-docker run -it --rm --env-file .env ghcr.io/android-sms-gateway/cli \
-  send --phone '+12025550123' 'Hello, Dr. Turk!'
+docker run -it --rm --env-file .env ghcr.io/android-sms-gateway/cli \
+  send --phones '+12025550123' 'Hello, Dr. Turk!'

---

168-173: Optional: Add a brief security caution before CLI credentials example.

Reinforce that passing passwords via flags may leak via shell history/process list.

Suggestion:

-Credentials can also be passed via CLI options:
+Credentials can also be passed via CLI options:
+
+Note: Passing credentials via flags may expose them in shell history and process listings. Prefer env vars or a `.env` file when possible.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9d851a7 and a3bcbf6.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: goreleaser

🔇 Additional comments (1)

README.md (1)

171-171: Correct placement of global options before subcommand.

Verified — the only occurrence is README.md:171 and it correctly places -u/-p before the subcommand:

smsgate -u <username> -p <password> send --phones '+12025550123' 'Hello, Dr. Turk!'