History

Taylor Mullen 1a84d8f674 Test: Add comprehensive tests for useToolScheduler hook - Introduces a suite of tests for the hook, covering various scenarios including: - Successful tool execution - Tool not found errors - Errors during - Errors during tool execution - Tool confirmation (approved and cancelled) - (currently skipped) - Live output updates - (currently skipped) - Cancellation of tool calls (before execution and during approval) - (currently skipped) - Execution of multiple tool calls - Preventing scheduling while other calls are running - (currently skipped) - Includes tests for the utility function to ensure correct mapping of tool call states to display objects. - Mocks dependencies like , , and individual instances. - Uses fake timers to control asynchronous operations. Note: Some tests involving complex asynchronous interactions (confirmations, live output, cancellations) are currently skipped due to challenges in reliably testing these scenarios with the current setup. These will be addressed in future work.		2025-05-31 02:55:36 -07:00
..
src	Test: Add comprehensive tests for useToolScheduler hook	2025-05-31 02:55:36 -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	Rename server->core (#638 )	2025-05-30 18:25:47 -07:00
tsconfig.json	Rename server->core (#638 )	2025-05-30 18:25:47 -07:00
vitest.config.ts	feat: Publish test coverage summaries to PRs (#513 )	2025-05-27 12:45:28 -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.