这是indexloc提供的服务,不要输入任何密码
Skip to content

Conversation

@shahmeersensei
Copy link

🌟 Overview

This PR enhances Grok CLI with comprehensive documentation and safety features, making it easier and safer for users and contributors.


✅ Changes Introduced

1. Documentation

  • PRIVACY.md — details data sent to APIs, local storage, API keys, and telemetry configuration.
  • SAFE_MODE.md — explains Safe Mode levels (interactive, semi-automated, automated) and relevant flags (--dry-run, --confirm, --never-send-files).
  • SECURITY.md — provides responsible vulnerability reporting instructions and response process.
  • CONTRIBUTING.md — guides developers on setup, branching, commits, coding style, testing, and pull requests.

2. README.md Updates

  • Added references to new safety flags and documentation files.
  • Highlights Safe Mode, privacy, and security considerations for users.

3. CLI Safety Features

  • Safe Mode is enabled by default.
  • Optional semi-automated and automated modes.
  • --dry-run previews commands before execution.
  • --confirm prompts for confirmation before running commands.
  • --never-send-files ensures no code is uploaded accidentally.
  • Telemetry opt-in/opt-out available.

🔧 Motivation

  • Improve clarity and safety for all users.
  • Encourage responsible usage of Grok CLI.
  • Provide a clear guide for contributors to follow best practices.

📌 Checklist

  • All required markdown documentation files added.
  • README.md updated with references to safety flags and new docs.
  • Examples and instructions verified for correctness.
  • Formatting and structure consistent across all documentation.

💡 Notes for Maintainers

  • All documentation aligns with current CLI behavior.
  • No functional code changes; only documentation and safety flag guidance.
  • This PR ensures that users can safely explore and contribute to Grok CLI.

Maintained with ❤️ by the open-source community.

@shahmeersensei
Copy link
Author

Hi maintainers! 👋

This PR adds comprehensive documentation and safety guidance to Grok CLI, including:

  • PRIVACY.md — explains data usage and local storage
  • SAFE_MODE.md — Safe Mode levels and safety flags
  • SECURITY.md — responsible vulnerability reporting
  • CONTRIBUTING.md — contributor setup, style, and workflow
  • README.md updates — references new docs and safety flags

All additions are documentation-only; no functional code changes were made.

This should help users understand and safely use Grok CLI, and provide clear guidelines for contributors.

Thanks for reviewing! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant