Skip to content

docs: add vi mode shortcuts and clarify MCP/custom sandbox setup#23853

Merged
g-samroberts merged 7 commits intogoogle-gemini:mainfrom
chrisjcthomas:codex/issue-23825-docs
May 7, 2026
Merged

docs: add vi mode shortcuts and clarify MCP/custom sandbox setup#23853
g-samroberts merged 7 commits intogoogle-gemini:mainfrom
chrisjcthomas:codex/issue-23825-docs

Conversation

@chrisjcthomas
Copy link
Copy Markdown
Contributor

@chrisjcthomas chrisjcthomas commented Mar 26, 2026

Summary

  • add a vi mode shortcuts reference covering the currently supported motions, edits, find commands, and yank/paste actions
  • add a concise SQLite MCP quick start to the README using the current uvx mcp-server-sqlite flow
  • clarify that BUILD_SANDBOX automatic custom image builds only work when running Gemini CLI from source, while npm installs need a prebuilt image

Testing

  • not run (docs only)

Closes #23825

@chrisjcthomas chrisjcthomas requested review from a team as code owners March 26, 2026 03:24
@gemini-code-assist
Copy link
Copy Markdown
Contributor

gemini-code-assist Bot commented Mar 26, 2026

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for the Gemini CLI by providing detailed instructions for Vi mode usage and streamlining the setup process for the SQLite MCP server. It also clarifies an important distinction regarding custom sandbox image builds, ensuring users understand the prerequisites based on their CLI installation method.

Highlights

  • Vi Mode Shortcuts: Added a comprehensive reference for Vi mode shortcuts, covering mode switching, navigation, editing, find, replace, yank, and paste actions in NORMAL mode.
  • SQLite MCP Quick Start: Introduced a concise quick start guide for setting up and using the SQLite MCP server in the README, including uvx installation and settings.json configuration.
  • Custom Sandbox Setup Clarification: Clarified the requirements for building custom sandbox images, specifying that automatic BUILD_SANDBOX builds are only supported when running the Gemini CLI from source, and npm installs require a prebuilt image.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist Bot reviewed Mar 26, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation across several files. It adds a quick start guide for setting up a SQLite reference server in README.md. Clarifications regarding the use of BUILD_SANDBOX for custom sandbox builds, specifically its limitation to source installations versus npm installations, have been added to docs/cli/sandbox.md and docs/reference/configuration.md. Additionally, a comprehensive section detailing Vi mode keyboard shortcuts, including mode switching, navigation, editing, and find/replace/yank/paste commands, has been added to docs/reference/keyboard-shortcuts.md. There is no feedback to provide.

Note: Security Review has been skipped due to the limited scope of the PR.

@gemini-cli gemini-cli Bot added area/documentation Gemini CLI documentation tasks and issues help wanted We will accept PRs from all issues marked as "help wanted". Thanks for your support! labels Mar 26, 2026
@chrisjcthomas
Copy link
Copy Markdown
Contributor Author

chrisjcthomas commented Mar 26, 2026

@g-samroberts this is the docs follow-up for #23825 that you labeled and assigned. It now covers the vi mode shortcuts, the SQLite MCP quick start, and the BUILD_SANDBOX source-vs-npm clarification. I also applied a small accuracy follow-up on the I vim binding description after an independent review. If you have a chance, I’d appreciate a look.

marsam2489-lang
marsam2489-lang approved these changes Mar 27, 2026
View reviewed changes
Copy link
Copy Markdown

@marsam2489-lang marsam2489-lang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good

@g-samroberts g-samroberts self-assigned this Apr 2, 2026
@g-samroberts g-samroberts added this pull request to the merge queue May 7, 2026
Merged via the queue into google-gemini:main with commit 4fd411a May 7, 2026
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@g-samroberts g-samroberts g-samroberts approved these changes

+2 more reviewers

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

@marsam2489-lang marsam2489-lang marsam2489-lang approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@g-samroberts g-samroberts

Labels

area/documentation Gemini CLI documentation tasks and issues help wanted We will accept PRs from all issues marked as "help wanted". Thanks for your support!

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: add vi mode shortcuts and clarify MCP/custom sandbox setup

3 participants

@chrisjcthomas @g-samroberts @marsam2489-lang