Referencia API

Documentación completa de la API de Gemini CLI con descripciones detalladas de métodos, parámetros y ejemplos prácticos.

Secciones API

Navegar por diferentes categorías de API

API Principal

API principal para interactuar con modelos Gemini y gestionar conversaciones

API de Plugin

API para desarrollar plugins y extensiones personalizados

API de Configuración

API para gestionar configuración y ajustes del CLI

API de Herramientas

API para gestionar y ejecutar herramientas integradas

API Principal

API principal para interactuar con modelos Gemini y gestionar conversaciones

chat()

Iniciar sesión de chat interactiva con Gemini

Firma:

chat(options?: ChatOptions): Promise<ChatSession>

Ejemplo:

import { GeminiCLI } from '@google/generative-ai-cli';

const cli = new GeminiCLI();
const session = await cli.chat({
  model: 'gemini-pro',
  temperature: 0.7
});

ask()

Enviar un prompt y recibir respuesta

Firma:

ask(prompt: string, options?: AskOptions): Promise<string>

Ejemplo:

const response = await cli.ask("¿Qué es el aprendizaje automático?", {
  maxTokens: 1000,
  temperature: 0.5
});

analyze()

Analizar archivos o código con asistencia de IA

Firma:

analyze(files: string[], options?: AnalyzeOptions): Promise<AnalysisResult>

Ejemplo:

const analysis = await cli.analyze(['src/main.js'], {
  type: 'code-review',
  includeMetrics: true
});

API de Plugin

API para desarrollar plugins y extensiones personalizados

registerPlugin()

Registrar nuevo plugin con el CLI

Firma:

registerPlugin(plugin: Plugin): void

Ejemplo:

const myPlugin = {
  name: 'my-custom-plugin',
  version: '1.0.0',
  commands: {
    'custom-command': async (args) => {
      // Lógica del plugin aquí
      return 'Plugin ejecutado exitosamente';
    }
  }
};

cli.registerPlugin(myPlugin);

createTool()

Crear herramienta personalizada para IA

Firma:

createTool(definition: ToolDefinition): Tool

Ejemplo:

const weatherTool = cli.createTool({
  name: 'get_weather',
  description: 'Obtener clima actual para una ubicación',
  parameters: {
    location: { type: 'string', required: true }
  },
  execute: async ({ location }) => {
    // Obtener datos del clima
    return `Clima en ${location}: Soleado, 25°C`;
  }
});