chore/hide-system-scan-from-help-text

[dylanpulver]

This PR hides the system-scan text from the CLI help text:

Summary by CodeRabbit

• New Features

  • Introduced a hidden command in the command-line interface for sorting vulnerabilities by score, enhancing command organization without altering functionality.

• Bug Fixes

  • No bug fixes were included in this release.

[coderabbitai]

Walkthrough

The change involves modifying the @scan_system_app.command decorator for the sort_vulns_by_score function by adding the hidden=True parameter. This adjustment ensures that the command will not appear in the command-line interface's help output, thereby limiting its visibility to users while keeping the function's core functionality intact.

Changes

Files	Change Summary
safety/scan/command.py	Modified @scan_system_app.command to include hidden=True in sort_vulns_by_score function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant CommandSystem

    User->>CLI: Request help
    CLI->>CommandSystem: Fetch command list
    CommandSystem-->>CLI: Return visible commands
    CLI-->>User: Display help output

Loading

Poem

In the meadow, I hop with glee,
A hidden command, just for me! 🐇
With secrets tucked away from sight,
I'll sort the scores, oh what a delight!
So hush now, dear friends, don’t you peek,
For this little change makes us unique! 🌼

---

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.

CodeRabbit Configuration 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.

Early access features: disabled

We are currently testing the following features in early access:

• Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues on the discussion post.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 96ddcb5 and 011fc95.

Files selected for processing (1)

• safety/scan/command.py (1 hunks)

Additional comments not posted (1)

safety/scan/command.py (1)

513-513: LGTM! Verify the impact on the CLI.

The hidden=True parameter has been added to hide the system_scan command from the CLI help output.

Run the following script to verify that the system_scan command is not displayed in the CLI help output: