mirror of
https://github.com/google-gemini/gemini-cli
synced 2026-04-21 13:37:17 +00:00
add233c504
This commit introduces the initial codebase for the Gemini Code CLI, a command-line interface designed to facilitate interaction with the Gemini API for software engineering tasks.
The code was migrated from a previous git repository as a single squashed commit.
Core Features & Components:
* **Gemini Integration:** Leverages the `@google/genai` SDK to interact with the Gemini models, supporting chat history, streaming responses, and function calling (tools).
* **Terminal UI:** Built with Ink (React for CLIs) providing an interactive chat interface within the terminal, including input prompts, message display, loading indicators, and tool interaction elements.
* **Tooling Framework:** Implements a robust tool system allowing Gemini to interact with the local environment. Includes tools for:
* File system listing (`ls`)
* File reading (`read-file`)
* Content searching (`grep`)
* File globbing (`glob`)
* File editing (`edit`)
* File writing (`write-file`)
* Executing bash commands (`terminal`)
* **State Management:** Handles the streaming state of Gemini responses and manages the conversation history.
* **Configuration:** Parses command-line arguments (`yargs`) and loads environment variables (`dotenv`) for setup.
* **Project Structure:** Organized into `core`, `ui`, `tools`, `config`, and `utils` directories using TypeScript. Includes basic build (`tsc`) and start scripts.
This initial version establishes the foundation for a powerful CLI tool enabling developers to use Gemini for coding assistance directly in their terminal environment.
---
Created by yours truly: __Gemini Code__
57 lines
1.6 KiB
TypeScript
57 lines
1.6 KiB
TypeScript
import { FunctionDeclaration } from "@google/genai";
|
|
import { ToolResult } from "./ToolResult.js";
|
|
import { ToolCallConfirmationDetails } from "../ui/types.js";
|
|
|
|
/**
|
|
* Interface representing the base Tool functionality
|
|
*/
|
|
export interface Tool<TParams = unknown, TResult extends ToolResult = ToolResult> {
|
|
/**
|
|
* The internal name of the tool (used for API calls)
|
|
*/
|
|
name: string;
|
|
|
|
/**
|
|
* The user-friendly display name of the tool
|
|
*/
|
|
displayName: string;
|
|
|
|
/**
|
|
* Description of what the tool does
|
|
*/
|
|
description: string;
|
|
|
|
/**
|
|
* Function declaration schema from @google/genai
|
|
*/
|
|
schema: FunctionDeclaration;
|
|
|
|
/**
|
|
* Validates the parameters for the tool
|
|
* @param params Parameters to validate
|
|
* @returns An error message string if invalid, null otherwise
|
|
*/
|
|
invalidParams(params: TParams): string | null;
|
|
|
|
/**
|
|
* Gets a pre-execution description of the tool operation
|
|
* @param params Parameters for the tool execution
|
|
* @returns A markdown string describing what the tool will do
|
|
* Optional for backward compatibility
|
|
*/
|
|
getDescription(params: TParams): string;
|
|
|
|
/**
|
|
* Determines if the tool should prompt for confirmation before execution
|
|
* @param params Parameters for the tool execution
|
|
* @returns Whether execute should be confirmed.
|
|
*/
|
|
shouldConfirmExecute(params: TParams): Promise<ToolCallConfirmationDetails | false>;
|
|
|
|
/**
|
|
* Executes the tool with the given parameters
|
|
* @param params Parameters for the tool execution
|
|
* @returns Result of the tool execution
|
|
*/
|
|
execute(params: TParams): Promise<TResult>;
|
|
}
|