History

Taylor Mullen 7928c1727f Configure linter + prettier. - This is based on existing expectations for TS code in Google-esc repos. - First part of the change (we have not run any linter or formatting commands). After this changeset goes in I'll do a mass changeset push. Fixes https://b.corp.google.com/issues/411384603		2025-04-17 15:29:34 -07:00
..
src	Fix build break (tool -> tools).	2025-04-17 17:25:01 -04:00
README.md	docs: Add setup instructions for API key to README (#1 )	2025-04-17 11:59:12 -07:00
package.json	Configure linter + prettier.	2025-04-17 15:29:34 -07:00
tsconfig.json	Initial commit of Gemini Code CLI	2025-04-17 13:19:55 -04:00

README.md

Gemini Code CLI

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

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 Code 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.