Describe global options for cloudai CLI

[amaslenn]

Summary

Addresses internal bug.

Test Plan

Review doc locally

Additional Notes

—

[coderabbitai]

Warning

Rate limit exceeded

@amaslenn has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between aac9cf0 and bedeb67.

📒 Files selected for processing (1)

• doc/index.md (1 hunks)

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

Documentation update to doc/index.md adding two global command-line options for the cloudai CLI: --log-file for file-based logging and --log-level for controlling output verbosity. No functional code changes or execution flow modifications.

Changes

Cohort / File(s)	Summary
Documentation Updates doc/index.md	Added global CLI options documentation: --log-file (logs to file, default debug.log, DEBUG level and higher) and --log-level (sets stdout logging level, default INFO)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Pure documentation changes with no code logic or behavioral modifications
• Single file with straightforward content additions
• Verify option descriptions match implementation and default values are accurate

Poem

🐰 A doc update hops into view,
With logging options fresh and new,
--log-file and --log-level bright,
Guiding users through debug's light! ✨

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding documentation for global options in the cloudai CLI, which aligns with the doc/index.md updates.
Description check	✅ Passed	The description is related to the changeset, referencing an internal bug fix and providing a test plan appropriate for documentation changes.

---

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

[greptile-apps]

Greptile Summary

Added documentation for global cloudai CLI options (--log-file and --log-level) that were previously undocumented.

• Documents --log-file option with default value debug.log and DEBUG+ logging behavior
• Documents --log-level option with default value INFO for stdout
• Placement is appropriate before mode-specific usage examples
• Content is accurate based on implementation in src/cloudai/cli/cli.py

Confidence Score: 5/5

• This PR is safe to merge with no risk
• Documentation-only change that accurately describes existing CLI options. Verified against implementation in cli.py - all descriptions match the actual behavior. No code changes, no tests needed.
• No files require special attention

Important Files Changed

Filename	Overview
doc/index.md	Added documentation for global CLI options (--log-file and --log-level) with accurate descriptions

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI as CloudAI CLI
    participant Logger as Logging System
    participant File as debug.log

    User->>CLI: cloudai --log-file <path> --log-level <level> <command>
    CLI->>Logger: setup_logging(log_file, log_level)
    Logger->>Logger: Configure handlers (stdout + file)
    Logger->>File: Create/Open debug.log
    Logger->>Logger: Set stdout level (default: INFO)
    Logger->>Logger: Set file level (DEBUG)
    Logger-->>CLI: Logging configured
    CLI->>CLI: Execute command (run/dry-run/install/etc)
    CLI->>Logger: Log messages
    Logger->>User: Display logs (INFO+ level)
    Logger->>File: Write logs (DEBUG+ level)

Loading

[greptile-apps]

_{1 file reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f5b2ceb and aac9cf0.

📒 Files selected for processing (1)

• doc/index.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: Greptile Review

🔇 Additional comments (1)

doc/index.md (1)

47-49: The CLI options --log-file and --log-level are both implemented in src/cloudai/cli/cli.py and match the documentation. The defaults are correctly set to debug.log and INFO respectively, and the file handler is configured to capture DEBUG and higher level entries while console output uses the specified log level. No changes needed.