summaryrefslogtreecommitdiff
path: root/packages/cli/src/tools/Tool.ts
diff options
context:
space:
mode:
authorTaylor Mullen <[email protected]>2025-04-15 21:41:08 -0700
committerTaylor Mullen <[email protected]>2025-04-17 13:19:55 -0400
commitadd233c5043264d47ecc6d3339a383f41a241ae8 (patch)
tree3d80d412ed805007132cf44257bbd7667005dcd8 /packages/cli/src/tools/Tool.ts
Initial commit of Gemini Code CLI
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__
Diffstat (limited to 'packages/cli/src/tools/Tool.ts')
-rw-r--r--packages/cli/src/tools/Tool.ts57
1 files changed, 57 insertions, 0 deletions
diff --git a/packages/cli/src/tools/Tool.ts b/packages/cli/src/tools/Tool.ts
new file mode 100644
index 00000000..c1ef26ec
--- /dev/null
+++ b/packages/cli/src/tools/Tool.ts
@@ -0,0 +1,57 @@
+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>;
+}