跳转至

认证设置

认证设置

Gemini CLI 需要您通过 Google AI 服务进行身份验证。首次启动时,您需要配置以下一种认证方式:

  1. 使用 Google 账号登录 (Gemini Code Assist):

    • 此选项允许您使用 Google 账号登录
    • 首次启动时,Gemini CLI 会引导您进入网页进行认证。认证后,您的凭证将缓存在本地,后续运行可跳过网页登录
    • 注意:网页登录必须在能与运行 Gemini CLI 的机器通信的浏览器中完成(具体来说,浏览器会被重定向到 Gemini CLI 正在监听的 localhost URL)
    • 以下情况用户可能需要指定 GOOGLE_CLOUD_PROJECT:
    • 您拥有 Google Workspace 账号。Google Workspace 是为企业和组织提供的付费服务,包含一系列生产力工具,如自定义邮箱域名(例如 your-name@your-company.com)、增强安全功能和管理控制。这类账号通常由雇主或学校管理。
    • 您是已授权的 Code Assist 用户。这可能发生在您之前购买过 Code Assist 许可证或通过 Google 开发者计划获取过许可证。
    • 如果您属于以上任一情况,必须首先配置要使用的 Google Cloud 项目 ID,启用 Gemini for Cloud API配置访问权限。您可以使用以下命令在当前 shell 会话中临时设置环境变量:
      export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"
      
      • 如需重复使用,您可以将环境变量添加到 .env 文件(位于项目目录或用户主目录)或 shell 配置文件(如 ~/.bashrc~/.zshrc~/.profile)。例如,以下命令将环境变量添加到 ~/.bashrc 文件:
        echo 'export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"' >> ~/.bashrc
        source ~/.bashrc
        
  2. Gemini API 密钥:

    • 从 Google AI Studio 获取 API 密钥:https://aistudio.google.com/app/apikey
    • 设置 GEMINI_API_KEY 环境变量。在以下方法中,将 YOUR_GEMINI_API_KEY 替换为您从 Google AI Studio 获取的 API 密钥:
    • 您可以使用以下命令在当前 shell 会话中临时设置环境变量:
      export GEMINI_API_KEY="YOUR_GEMINI_API_KEY"
      
    • 如需重复使用,您可以将环境变量添加到 .env 文件(位于项目目录或用户主目录)或 shell 配置文件(如 ~/.bashrc~/.zshrc~/.profile)。例如,以下命令将环境变量添加到 ~/.bashrc 文件:
      echo 'export GEMINI_API_KEY="YOUR_GEMINI_API_KEY"' >> ~/.bashrc
      source ~/.bashrc
      
  3. 使用 Google 账号登录 (适用于 Workspace 版 Gemini Code Assist 或已授权 Code Assist 用户):

    (更多信息请参阅:https://developers.google.com/gemini-code-assist/resources/faqs#gcp-project-requirement)

    • 在以下情况下使用此选项:

    • 您拥有 Google Workspace 账号。Google Workspace 是为企业和组织提供的付费服务,包含一系列生产力工具,如自定义邮箱域名(例如 your-name@your-company.com)、增强安全功能和管理控制。这类账号通常由雇主或学校管理。

    • 您是已授权的 Code Assist 用户。这可能发生在您之前购买过 Code Assist 许可证或通过 Google 开发者计划获取过许可证。

    • 如果您属于以上任一情况,必须首先配置要使用的 Google Cloud 项目 ID,启用 Gemini for Cloud API配置访问权限。您可以使用以下命令在当前 shell 会话中临时设置环境变量:

      export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"
      

    • 如需重复使用,您可以将环境变量添加到 .env 文件(位于项目目录或用户主目录)或 shell 配置文件(如 ~/.bashrc~/.zshrc~/.profile)。例如,以下命令将环境变量添加到 ~/.bashrc 文件:
      echo 'export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"' >> ~/.bashrc
      source ~/.bashrc
      
    • 启动时,Gemini CLI 会引导您进入网页进行认证。认证后,您的凭证将缓存在本地,后续运行可跳过网页登录
    • 注意:网页登录必须在能与运行 Gemini CLI 的机器通信的浏览器中完成(具体来说,浏览器会被重定向到 Gemini CLI 正在监听的 localhost URL)
  4. Vertex AI:

    • 如果不使用 express 模式:
    • 确保您拥有 Google Cloud 项目并已启用 Vertex AI API
    • 设置 Application Default Credentials (ADC),使用以下命令:
      gcloud auth application-default login
      
      更多信息请参阅为 Google Cloud 设置 Application Default Credentials
    • 设置 GOOGLE_CLOUD_PROJECTGOOGLE_CLOUD_LOCATIONGOOGLE_GENAI_USE_VERTEXAI 环境变量。在以下方法中,将 YOUR_PROJECT_IDYOUR_PROJECT_LOCATION 替换为您项目的相关值:
      • 您可以使用以下命令在当前 shell 会话中临时设置这些环境变量:
        export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"
        export GOOGLE_CLOUD_LOCATION="YOUR_PROJECT_LOCATION" # 例如 us-central1
        export GOOGLE_GENAI_USE_VERTEXAI=true
        
      • 如需重复使用,您可以将环境变量添加到 .env 文件(位于项目目录或用户主目录)或 shell 配置文件(如 ~/.bashrc~/.zshrc~/.profile)。例如,以下命令将环境变量添加到 ~/.bashrc 文件:
        echo 'export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"' >> ~/.bashrc
        echo 'export GOOGLE_CLOUD_LOCATION="YOUR_PROJECT_LOCATION"' >> ~/.bashrc
        echo 'export GOOGLE_GENAI_USE_VERTEXAI=true' >> ~/.bashrc
        source ~/.bashrc
        
    • 如果使用 express 模式:
    • 设置 GOOGLE_API_KEY 环境变量。在以下方法中,将 YOUR_GOOGLE_API_KEY 替换为 express 模式提供的 Vertex AI API 密钥:
      • 您可以使用以下命令在当前 shell 会话中临时设置这些环境变量:
        export GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"
        export GOOGLE_GENAI_USE_VERTEXAI=true
        
      • 如需重复使用,您可以将环境变量添加到 .env 文件(位于项目目录或用户主目录)或 shell 配置文件(如 ~/.bashrc~/.zshrc~/.profile)。例如,以下命令将环境变量添加到 ~/.bashrc 文件:
        echo 'export GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"' >> ~/.bashrc
        echo 'export GOOGLE_GENAI_USE_VERTEXAI=true' >> ~/.bashrc
        source ~/.bashrc