Sdp Fn

sdp-fn

使用 sdp-fn CLI 作为 SDP 函数计算（SDP Function Computing）Web 前后端开发平台的主要控制面，完成认证、部署、能力接入、配置管理和运维等操作。

概述

SDP-FN（SDP Function Computing）是一个面向 Web 前后端服务的函数计算平台。开发者通过 sdp-fn CLI 工具完成项目的初始化、平台能力接入、本地开发、远程部署和运维检查。

使用本技能可以避免重复探索 CLI 命令语义、扩展包 API 细节和平台特有的操作约束。

何时使用

在以下场景中调用本技能：

• 需要登录/登出 SDP-FN 平台或查看当前身份
• 需要管理 sdp-fn CLI 的本地配置
• 需要将当前项目部署到 SDP-FN 平台
• 需要升级 sdp-fn CLI 自身版本
• 需要向项目安装平台扩展包（sdp-fn add）
• 需要在前端使用 @sdp-fn/api 调用后端 API 路由
• 需要配置 @sdp-fn/vite 插件以在本地开发中代理 API 请求
• 需要接入 @sdp-fn/uc 用户认证（浏览器端登录/服务端用户读取）
• 需要接入 @sdp-fn/mongodb 数据库
• 需要接入 @sdp-fn/cs 对象存储
• 需要了解平台能力总览和常见工作流

快速上手

# 首次使用：配置服务器并登录
sdp-fn config set-local server https://api.example.com
sdp-fn login

# 安装扩展包
sdp-fn add @sdp-fn/uc --env preproduction
sdp-fn add @sdp-fn/mongodb --env preproduction

# 部署
sdp-fn deploy --env preproduction

决策树

根据用户请求路由到正确的参考文件：

核心工作流

1. 分类请求：判断用户意图是认证、配置、部署、能力接入还是运维检查。 2. 确认上下文：在执行变更操作前先确认身份和配置：

• 使用 sdp-fn whoami 确认登录状态
• 使用 sdp-fn config get-local 确认服务器配置
• 确保在项目根目录（包含 package.json）执行命令

3. 选择最小正确操作：

• 如果是新增能力，使用 sdp-fn add 安装扩展包
• 如果是部署，先 --dry-run 验证，再正式部署
• 如果是配置问题，优先使用 sdp-fn config 而非手动编辑文件

4. 优先项目已有工作流：如果项目模板提供了 npm run dev 或 npm run deploy 脚本，优先使用它们。 5. 部署后检查：部署后使用 sdp-fn deploy --dry-run 验证构建流程。

命令选择

认证相关

sdp-fn login                          # 浏览器 OAuth 登录
sdp-fn login --device                 # 设备码流程登录
sdp-fn login --api-key <key> --key-id <id>  # 非交互式 API Key 导入
sdp-fn logout                         # 登出
sdp-fn whoami                         # 查看当前登录用户

选择规则：

• 交互式环境：使用 sdp-fn login（自动尝试浏览器流，不可用时回退设备流）
• 非交互式环境（CI/Agent）：使用 sdp-fn login --api-key <key> --key-id <id>
• 强制设备流：使用 sdp-fn login --device
• 身份不确定时：先 sdp-fn whoami

配置管理

sdp-fn config get-local               # 查看所有配置
sdp-fn config get-local server        # 查看指定配置项
sdp-fn config set-local server <url>  # 设置配置项
sdp-fn config unset-local <key>       # 移除配置项
sdp-fn config path-local              # 查看配置文件路径

选择规则：

• 首次使用前：必须配置 server
• 调试问题时：使用 get-local 确认当前配置
• 需要切换服务器时：使用 set-local server <url>

部署

sdp-fn deploy                                    # 部署到默认环境 (preproduction)
sdp-fn deploy --env production                   # 部署到生产环境
sdp-fn deploy --env development                  # 部署到开发环境
sdp-fn deploy --dry-run                          # 试运行（构建但不上传）
sdp-fn deploy --verbose                          # 详细输出
sdp-fn deploy --skip-faas                        # 跳过 FaaS 发布
sdp-fn deploy --app-name <name>                  # 指定应用名

选择规则：

• 日常部署：sdp-fn deploy
• 先验证构建：sdp-fn deploy --dry-run
• 排查构建失败：sdp-fn deploy --verbose
• 生产部署：sdp-fn deploy --env production

CLI 升级

sdp-fn upgrade                        # 检查并升级
sdp-fn upgrade --check                # 仅检查新版本
sdp-fn upgrade --status               # 查看最近升级状态

选择规则：

• 日常使用：无需手动操作，CLI 自动检查
• 需要立即升级：sdp-fn upgrade
• 只想确认版本：sdp-fn upgrade --check

扩展包安装

sdp-fn add @sdp-fn/uc                 # 安装 UC 认证
sdp-fn add @sdp-fn/uc --env preproduction  # 安装并执行 post-add 钩子
sdp-fn add @sdp-fn/mongodb            # 安装 MongoDB
sdp-fn add @sdp-fn/cs                 # 安装对象存储
sdp-fn add @sdp-fn/api                # 安装 API 客户端
sdp-fn add @sdp-fn/vite               # 安装 Vite 插件

选择规则：

• 需要用户认证功能 → @sdp-fn/uc
• 需要数据库存储 → @sdp-fn/mongodb
• 需要文件上传/对象存储 → @sdp-fn/cs
• 需要前端调用后端 API 的类型安全客户端 → @sdp-fn/api
• 需要 Vite 开发环境集成 → @sdp-fn/vite
• 如果指定 --env，安装后会自动执行 post-add 钩子（如自动开通 MongoDB 服务）

操作规则

• 从项目根目录执行 sdp-fn 命令，除非命令显式接受不同的工作目录。
• 优先使用项目模板提供的 npm run dev / npm run deploy 脚本。
• 使用 .env.development 和 .env.production 管理服务端环境变量，不要假设 .env 是部署时的真实来源。
• 使用 sdp-fn login --api-key <key> --key-id <id> 实现确定性非交互式认证。
• 裸 sdp-fn login 是交互式的（浏览器/设备流），不要用于 Agent 自动化。
• sdp-fn add 命令不保证输出稳定的 JSON 格式，不要依赖其结构化输出。
• FN_* 是保留环境变量前缀，不要在用户 .env 文件中使用。

反模式

• 在需要 /api/* 路由的项目中不安装 @sdp-fn/api 或 @sdp-fn/vite。
• 在已有对应扩展包的模板中重复安装相同的包。
• 在 Agent 自动化中使用裸 sdp-fn login（应使用 --api-key）。
• 假设 sdp-fn add 返回结构化 JSON 输出。
• 忘记在部署前执行 sdp-fn whoami 确认登录状态。
• 将 @sdp-fn/mongodb 或 @sdp-fn/uc/server 用在浏览器端代码中。
• 在服务端路由中暴露 UC 密钥或 MongoDB 连接字符串。

参考文件

• 平台能力总览与扩展包选择 → ./references/platform-capabilities.md
• 登录、登出、身份查看 → ./references/login.md
• 配置管理 → ./references/config.md
• 部署 → ./references/deploy.md
• CLI 升级 → ./references/upgrade.md
• 扩展包安装 → ./references/add.md
• @sdp-fn/api 前端 API 客户端 → ./references/api.md
• @sdp-fn/vite Vite 插件 → ./references/vite.md
• @sdp-fn/uc 用户认证 → ./references/uc.md
• @sdp-fn/mongodb 数据库 → ./references/mongodb.md
• @sdp-fn/cs 对象存储 → ./references/cs.md
• Agent 自动化边界 → ./references/automation-boundaries.md