Go to file

Jaana Dogan 81ba61df7f Improve readability issues This is only the first change of many changes. * Remove redundant autogenerated comments * Use the recommended file name style * Use camelCase for variable names * Don't introduce submodules for relevant types * Don't introduce constants like modules, these are implementation details * Remove empty files		2025-04-17 14:15:20 -07:00
.vscode	Initial commit of Gemini Code CLI	2025-04-17 13:19:55 -04:00
packages/cli	Improve readability issues	2025-04-17 14:15:20 -07:00
.gitignore	Initial commit of Gemini Code CLI	2025-04-17 13:19:55 -04:00
README.md	docs: Add setup instructions for API key to README (#1 )	2025-04-17 11:59:12 -07:00
package-lock.json	Initial commit of Gemini Code CLI	2025-04-17 13:19:55 -04:00
package.json	Initial commit of Gemini Code CLI	2025-04-17 13:19:55 -04:00
tsconfig.json	Initial commit of Gemini Code CLI	2025-04-17 13:19:55 -04:00

README.md

Gemini Code

Disclaimer: This README.md was created by gemini-code and this project was developed rapidly and currently lacks comprehensive testing, CI/CD pipelines, and other quality-of-life features common in mature projects.

This repository contains the Gemini Code CLI tool.

Cloning and Contribution

This project uses Gerrit for version control. For details on the development workflow, including how to clone the repository and contribute changes, please refer to the Gerrit Dev Workflows.

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 the entire project, including the CLI package, run the following command from the root directory:

npm install
npm run build

This command installs dependencies and then runs the build script defined in the root package.json, which in turn executes the build scripts in all workspaces (including packages/cli).

Running

To start the Gemini Code CLI, run the following command from the root directory:

npm start

This command executes the start script defined in the root package.json, which specifically targets and runs the start script within the gemini-code-cli workspace.

Debugging

To debug the CLI application using VS Code:

Start the CLI in debug mode from the root directory:
```
npm run debug --workspace=gemini-code-cli
```
This command runs node --inspect-brk dist/gemini.js within the packages/cli directory, pausing execution until a debugger attaches.
In VS Code, 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.

Alternatively, you can use the "Launch Program" configuration in VS Code if you prefer to launch the currently open file directly, but the "Attach" method is generally recommended for debugging the main CLI entry point.