安装 CLI 并配置凭据

CodeMender 是一款自主 AI 代码安全智能体，可扫描、验证和修补代码库中的深层网络安全漏洞。在运行 CodeMender 之前，请下载 CLI 并初始化工作区选项。

架构和安全模型

CodeMender 采用本地优先执行模型：

  • 托管式推理引擎：在 Gemini Enterprise Agent Platform 上安全运行智能体推理、威胁建模和编排逻辑。 Google Cloud
  • 本地执行 CLI：源代码绝不会批量离开您的工作站或 CI/CD 容器。本地 cm CLI 工具可在本地沙盒中执行文件读取、本地 build 检查和概念验证 (PoC) 漏洞验证，并通过 Gemini Enterprise Agent Platform 上的 Interactions API 仅将精确的代码段和工具执行结果发送到云后端。

环境设置

如需开始使用 CodeMender，请下载并安装 CLI，配置您的 Google Cloud 凭据，然后初始化您的工作区。

下载并安装 CodeMender CLI

CodeMender CLI 二进制文件托管在 Artifact Registry 中。选择与您的操作系统对应的标签页，下载并安装 CLI。

Linux x86_64

如需下载并安装适用于 Linux (x86_64) 的 CodeMender CLI，请执行以下操作：

  1. 使用以下方法之一下载软件包：
    • gcloud CLI：运行以下命令： 
      gcloud artifacts generic download \
  --project=cmoc-prod \
  --location=us \
  --repository=codemender-cli-production \
  --package=cm \
  --version=stable \
  --name=cm-linux-amd64.zip \
  --destination=./
    • curl：运行以下命令： 
      curl -L -o cm-linux-amd64.zip "https://artifactregistry.googleapis.com/download/v1/projects/cmoc-prod/locations/us/repositories/codemender-cli-production/files/cm%3Astable%3Acm-linux-amd64.zip:download?alt=media"
  2. 安装 CLI： 
    unzip cm-linux-amd64.zip
chmod +x cm
sudo mv cm /usr/local/bin/cm

Linux ARM64

如需下载并安装适用于 Linux (ARM64) 的 CodeMender CLI，请执行以下操作：

  1. 使用以下方法之一下载软件包：
    • gcloud CLI：运行以下命令： 
      gcloud artifacts generic download \
  --project=cmoc-prod \
  --location=us \
  --repository=codemender-cli-production \
  --package=cm \
  --version=stable \
  --name=cm-linux-arm64.zip \
  --destination=./
    • curl：运行以下命令： 
      curl -L -o cm-linux-arm64.zip "https://artifactregistry.googleapis.com/download/v1/projects/cmoc-prod/locations/us/repositories/codemender-cli-production/files/cm%3Astable%3Acm-linux-arm64.zip:download?alt=media"
  2. 安装 CLI： 
    unzip cm-linux-arm64.zip
chmod +x cm
sudo mv cm /usr/local/bin/cm

macOS Intel

如需下载并安装适用于 macOS (Intel) 的 CodeMender CLI，请执行以下操作：

  1. 使用以下方法之一下载软件包：
    • gcloud CLI：运行以下命令： 
      gcloud artifacts generic download \
  --project=cmoc-prod \
  --location=us \
  --repository=codemender-cli-production \
  --package=cm \
  --version=stable \
  --name=cm-darwin-amd64.zip \
  --destination=./
    • curl：运行以下命令： 
      curl -L -o cm-darwin-amd64.zip "https://artifactregistry.googleapis.com/download/v1/projects/cmoc-prod/locations/us/repositories/codemender-cli-production/files/cm%3Astable%3Acm-darwin-amd64.zip:download?alt=media"
  2. 安装 CLI： 
    unzip cm-darwin-amd64.zip
chmod +x cm
mv cm /usr/local/bin/cm

macOS Apple Silicon

如需下载并安装适用于 macOS（Apple 芯片）的 CodeMender CLI，请执行以下操作：

  1. 使用以下方法之一下载软件包：
    • gcloud CLI：运行以下命令： 
      gcloud artifacts generic download \
  --project=cmoc-prod \
  --location=us \
  --repository=codemender-cli-production \
  --package=cm \
  --version=stable \
  --name=cm-darwin-arm64.zip \
  --destination=./
    • curl：运行以下命令： 
      curl -L -o cm-darwin-arm64.zip "https://artifactregistry.googleapis.com/download/v1/projects/cmoc-prod/locations/us/repositories/codemender-cli-production/files/cm%3Astable%3Acm-darwin-arm64.zip:download?alt=media"
  2. 安装 CLI： 
    unzip cm-darwin-arm64.zip
chmod +x cm
mv cm /usr/local/bin/cm

Windows x86_64

如需下载并安装适用于 Windows (x86_64) 的 CodeMender CLI，请执行以下操作：

  1. 使用以下方法之一下载软件包：
    • gcloud CLI：在 PowerShell 中运行以下命令： 
      gcloud artifacts generic download `
  --project=cmoc-prod `
  --location=us `
  --repository=codemender-cli-production `
  --package=cm `
  --version=stable `
  --name=cm-windows-amd64.zip `
  --destination=./
    • PowerShell：运行以下命令： 
      Invoke-WebRequest -Uri "https://artifactregistry.googleapis.com/download/v1/projects/cmoc-prod/locations/us/repositories/codemender-cli-production/files/cm%3Astable%3Acm-windows-amd64.zip:download?alt=media" -OutFile cm-windows-amd64.zip
  2. 安装 CLI： 
    Expand-Archive -Path cm-windows-amd64.zip -DestinationPath ./
# Move cm.exe to a permanent folder and add it to your system PATH (e.g. Environmental Variables)

Windows ARM64

如需下载并安装适用于 Windows (ARM64) 的 CodeMender CLI，请执行以下操作：

  1. 使用以下方法之一下载软件包：
    • gcloud CLI：在 PowerShell 中运行以下命令： 
      gcloud artifacts generic download `
  --project=cmoc-prod `
  --location=us `
  --repository=codemender-cli-production `
  --package=cm `
  --version=stable `
  --name=cm-windows-arm64.zip `
  --destination=./
    • PowerShell：运行以下命令： 
      Invoke-WebRequest -Uri "https://artifactregistry.googleapis.com/download/v1/projects/cmoc-prod/locations/us/repositories/codemender-cli-production/files/cm%3Astable%3Acm-windows-arm64.zip:download?alt=media" -OutFile cm-windows-arm64.zip
  2. 安装 CLI： 
    Expand-Archive -Path cm-windows-arm64.zip -DestinationPath ./
# Move cm.exe to a permanent folder and add it to your system PATH (e.g. Environmental Variables)

配置 Google Cloud 凭据

由于 CodeMender CLI 通过 Interactions API 与云端托管的推理引擎进行交互，因此您必须在环境中配置 Google Cloud 应用默认凭证 (ADC)。

如需进行身份验证，请运行以下命令并按照登录提示操作：

gcloud auth application-default login

初始化并配置 CodeMender

完成身份验证后，下一步应是在本地环境中初始化 CodeMender。初始化 CodeMender 会创建状态跟踪文件并建立与云端托管的推理引擎的连接设置，从而准备好本地工作区。

初始化工作区

从代码库的根目录运行 cm init，以创建本地状态跟踪文件并建立基准配置：

cm init

使用 --verify 标志测试与云端托管的推理引擎的连接，并验证工作区设置：

cm init --verify

配置参数 (config.yaml)

CodeMender 从 ~/.codemender/config.yaml 读取配置设置。您可以自定义以下部分：

版本控制系统 (VCS) 配置

在 vcs 下指定项目的版本控制系统类型。CodeMender 支持 Git、Mercurial 或自定义 VCS 配置：

Git 代码库

vcs:
  type: "git"

Mercurial 代码库

vcs:
  type: "mercurial"

自定义版本控制系统

为非标准 VCS 工具指定自定义命令映射：

vcs:
  type: "custom"
  commands:
    status: "svn status"
    diff:   "svn diff"
    stage:  "echo 'no staging needed'"
    reset:  "svn revert -R ."

构建和回归测试命令

定义 CodeMender 用于构建项目并执行单元测试和回归测试的确切 shell 命令：

build:
  command: "make build && make test"

交互式执行确认

配置工具确认行为，以确定 CLI 是否在运行本地命令或修改文件之前提示进行确认：

tools:
  confirm_execution: true