History

Taylor Mullen 6ca446bded fix(cli): Prevent truncation of first character in shell commands - The shell command processor was incorrectly truncating the first character of the command (e.g., 'ls' became 's') due to an erroneous `slice(1)` operation, likely introduced during a previous merge. This change removes the slice, ensuring the full command is processed. - Introduces unit tests for the shellCommandProcessor hook. - Fixes a minor grammatical issue in the display of GEMINI.md file count.		2025-05-20 00:23:12 -07:00
..
src	fix(cli): Prevent truncation of first character in shell commands	2025-05-20 00:23:12 -07:00
Dockerfile.sandbox	fix: set .npmrc in HOME dir before publishing (#206 )	2025-04-28 18:16:42 -07:00
README.md	Update Gemini Code verbiage -> Gemini CLI	2025-05-14 22:07:03 -07:00
index.ts	feat: add alias to the cli bin directive (#126 )	2025-04-23 01:04:34 +00:00
package.json	feat(cli): Implement /bug command and add open dependency (#428 )	2025-05-19 16:56:32 -07:00
tsconfig.json	fix: use flat config for react eslint plugin (#265 )	2025-05-06 08:48:26 -07:00
vitest.config.ts	Fix an issue where types/react was a different version from our main … (#231 )	2025-04-30 16:33:43 -07:00

README.md

Gemini CLI

This package contains the core command-line interface for Gemini CLI.

Setup

Get a Gemini API Key: Obtain your API key from Google AI Studio: https://aistudio.google.com/app/apikey
Set Environment Variable: Set the GEMINI_API_KEY environment variable to your obtained key. You can do this temporarily in your current shell session:
```
export GEMINI_API_KEY="YOUR_API_KEY"
```
Or add it to your shell's configuration file (like ~/.bashrc, ~/.zshrc, or ~/.profile) for persistence:
```
echo 'export GEMINI_API_KEY="YOUR_API_KEY"' >> ~/.bashrc # Or your preferred shell config file
source ~/.bashrc # Reload the config
```
Replace "YOUR_API_KEY" with your actual key.

Building

To build only the CLI package, navigate to this directory (packages/cli) and run:

npm run build

This command executes the TypeScript compiler (tsc) as defined in this package's package.json. Ensure dependencies have been installed from the root directory (npm install) first.

Running

To start the Gemini CLI directly from this directory:

npm start

This command executes node dist/gemini.js as defined in this package's package.json.

Debugging

To debug the CLI application using VS Code:

Start the CLI in debug mode from this directory (packages/cli):
```
npm run debug
```
This command runs node --inspect-brk dist/gemini.js, pausing execution until a debugger attaches.
In VS Code (opened at the root of the monorepo), use the "Attach" launch configuration (found in .vscode/launch.json). This configuration is set up to attach to the Node.js process listening on port 9229, which is the default port used by --inspect-brk.