diff --git a/README.md b/README.md index 1024cc0..f609d6e 100644 --- a/README.md +++ b/README.md @@ -17,17 +17,17 @@ The Security extension is an open-source Gemini CLI extension, built to enhance Install the Security extension by running the following command from your terminal *(requires Gemini CLI v0.4.0 or newer)*: ```bash -gemini extensions install https://github.com/gemini-cli-extensions/security +gemini extensions install https://github.com/gemini-cli-extensions/security --auto-update ``` +The `--auto-update` is optional: if specified, it will update to new versions as they are released. + ## Use the extension The Security extension adds the `/security:analyze` command to Gemini CLI which analyzes code changes on your current branch for common security vulnerabilities and provides an intelligent, Gemini-powered security report to improve the repository's security posture. Important: This report is a first-pass analysis, not a complete security audit. Use in combination with other tools and manual review. -Note: The /security:analyze command is currently designed for interactive use. Support for non-interactive sessions is planned for a future release (tracked in [issue #20](https://github.com/gemini-cli-extensions/security/issues/20)). - ### Customize the `/security:analyze` command By default, the `/security:analyze` command determines the scope of the analysis using `git diff --merge-base origin/HEAD`. However, to customize the scope, you can add instructions to the command using natural language. For example, to analyze all files in `scripts` folder, you can run the command as