快速开始

安装

项目内安装（推荐）

bash

pnpm add -D @spaceflow/cli

全局安装

bash

npm install -g @spaceflow/cli
# 或
pnpm add -g @spaceflow/cli

安装完成后，你可以通过 spaceflow 或简写 space 来调用命令。

验证安装

bash

spaceflow --help

初始化项目

bash

spaceflow setup

这会创建 .spaceflow/ 目录和默认配置文件。你也可以手动创建 .spaceflowrc 配置文件：

json

{
  "$schema": ".spaceflow/config-schema.json",
  "support": ["claudeCode"],
  "dependencies": {
    "@spaceflow/review": "latest"
  }
}

安装 Extension

使用 install 命令安装扩展：

bash

# 安装 review 扩展
spaceflow install @spaceflow/review

# 安装 publish 扩展
spaceflow install @spaceflow/publish

# 安装配置文件中的所有依赖
spaceflow install

安装后，Extension 会被注册到配置文件的 dependencies 字段，并自动关联到 support 中指定的编辑器目录。

常用命令

代码审查

bash

# 审查指定 PR
spaceflow review -p 123

# 审查两个分支之间的差异
spaceflow review -b main --head feature/xxx

# 使用指定 LLM 模式
spaceflow review -p 123 -l openai

版本发布

bash

# 发布版本
spaceflow publish

# 试运行（不实际发布）
spaceflow publish --dry-run

AI 智能提交

bash

# 自动生成 commit message
spaceflow commit

# 智能拆分为多个 commit
spaceflow commit --split

查看已安装的 Extension

bash

spaceflow list

构建 Extension

bash

# 构建所有 Extension
spaceflow build

# 监听模式
spaceflow build --watch

在 CI 中使用

Spaceflow 提供了预配置的 GitHub Actions，可以在 PR 中自动执行代码审查：

yaml

# .github/workflows/pr-review.yml
name: PR Review
on:
  pull_request:
    types: [opened, synchronize]

jobs:
  review:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: Lydanne/spaceflow@main
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          command: review
        env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

详细的 CI 配置请参考 GitHub Actions。

快速开始 ​

安装 ​

项目内安装（推荐） ​

全局安装 ​

验证安装 ​

初始化项目 ​

安装 Extension ​

常用命令 ​

代码审查 ​

版本发布 ​

AI 智能提交 ​

查看已安装的 Extension ​

构建 Extension ​

在 CI 中使用 ​

下一步 ​

快速开始

安装

项目内安装（推荐）

全局安装

验证安装

初始化项目

安装 Extension

常用命令

代码审查

版本发布

AI 智能提交

查看已安装的 Extension

构建 Extension

在 CI 中使用

下一步