快速开始

这是一条面向新用户的最短路径：安装 Cogna、初始化配置、构建索引、分析变更、执行检查。

1. 安装 Cogna

你可以从下载页选择最适合自己的方式：

• Desktop：图形界面体验
• CLI：适合终端、脚本和 CI
• SDK / VSCode：适合集成到开发流程

入口：/download

如果你只想先走 CLI，推荐：

# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/cogna-dev/cogna/v0.1.0/install.sh | sh

2. 在项目里初始化

进入你的仓库根目录：

cogna init

会生成 cogna.yml。最小示例：

schemaVersion: ciq-config/v2
profile: go-module
purl: pkg:golang/github.com/your-org/your-lib@1.0.0
source:
  repo: https://github.com/your-org/your-lib
  ref: main
inputs:
  include:
    - "**/*.go"
cache:
  type: local
  local:
    storeDir: .cogna/cache

3. 构建索引

cogna build

产物在 dist/：

• bundle.ciq.tgz：核心归档
• declarations.ndjson：声明索引
• manifest.json：元信息

4. 分析版本变化

准备好 dist/base 和 dist/target 后：

cogna diff

输出 dist/diff.json，用于判断“升级会不会影响调用方”。

5. 执行兼容性检查

cogna check

输出 dist/check.sarif.json，可直接接入代码扫描平台。

下一步

1. 继续看 构建索引
2. 学会读 分析变更
3. 把结果接入 持续集成
4. 想要图形化体验，使用 /download 中的 Desktop 版本