凡尔塞云
这个包提供了一种代理工具,用于从 Git 寄存器中部署项目,列出项目,检查部署状态,管理自定义域,并通过 Vercel REST API 设置或列出环境变量.
安装
npm install @framers/agentos-ext-cloud-vercel
同伴依赖 : @framers/agentos >=0.10.40。 。 。 .
使用量
import { AgentOS } from '@framers/agentos';
const agentos = await AgentOS.create({
extensionManifest: {
packs: [
{
package: '@framers/agentos-ext-cloud-vercel',
options: {
token: process.env.VERCEL_TOKEN,
teamId: process.env.VERCEL_TEAM_ID,
},
},
],
},
});
配置
| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
|---|---|---|---|---|
token | vercel.token | VERCEL_TOKEN | 对 | 空字符串 |
teamId | vercel.teamId | VERCEL_TEAM_ID | 没有 | undefined,个人账户范围 |
secrets | vercel.token, (中文(简体) ), vercel.teamId | 无 | 没有 | A. 背景情况 secrets空对象 |
从相应的选项, 选中的秘密地图, 然后是环境变量 . options.secrets 优先于上下文 secrets提供 teamId 作为查询参数,附于API请求后.
工具
| 工具 | 它会做什么 |
|---|---|
vercelDeploy | 从 Git 寄存器 URL 中部署一个工程, 如果不存在则创建此工程 . |
vercelListProjects | 列出带有框架的账户项目,链接Git仓库,以及最新的部署状态. |
vercelGetDeployment | 通过部署ID检查部署状态,URL和检查员链接. |
vercelConfigureDomain | 添加,去除,或列出项目域并检查 DNS 配置. |
vercelSetEnvVars | 设定或列出用于生产,预览,开发目标的项目环境变量. |
vercelDeploy
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
gitUrl | 字符串 | 对 | Git 仓库 URL . |
projectName | 字符串 | 没有 | Vercel 项目名,如果省略,则取自仓库名. |
framework | 字符串 | 没有 | 框架预设,例如 nextjs, (中文(简体) ), vite,或 gatsby; 省略后自动检测. |
buildCommand | 字符串 | 没有 | 构建命令覆盖 . |
outputDirectory | 字符串 | 没有 | 输出目录覆盖, 如 dist, (中文(简体) ), .next,或 build。 。 。 . |
envVars | 对象 | 没有 | 项目环境变量作为密钥值对. |
target | 字符串 | 没有 | 部署目标: production 或者说 preview; 默认计划 : production。 。 。 . |
vercelListProjects
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
limit | 编号 | 没有 | 要返回的最大项目数 . |
vercelGetDeployment
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
deploymentId | 字符串 | 对 | 部署 ID 或 URL 要检查 . |
vercelConfigureDomain
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
projectId | 字符串 | 对 | Vercel项目ID或名称. |
domain | 字符串 | 对 | 自定义域, 例如 example.com 或者说 www.example.com。 。 。 . |
action | 字符串 | 没有 | add, (中文(简体) ), remove, (中文(简体) ), list,或 check; 默认 : add。 。 。 . |
gitBranch | 字符串 | 没有 | Git 分支将域链接到 . |
vercelSetEnvVars
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
projectId | 字符串 | 对 | Vercel项目ID或名称. |
vars | 对象 | 没有 | 要设置的环境变量键值对 . |
action | 字符串 | 没有 | set 或者说 list; 默认 : set。 。 。 . |
target | 字符串数组 | 没有 | 可变目标 : production, (中文(简体) ), preview,以及 development; 默认所有列出的目标. |
页:1
活化需要一个Vercel API令牌. 如果缺少此令牌或用户- info认证请求失败, 则失败 .
Git URL 解析器接受 GitHub, GitLab, 和 Bitbucket URLs. 部署重用一个按名称发现的项目,或在搜索失败时试图创建它. 创建项目时会通过仓库、框架和构建设置。 部署在不等待完成的情况下返回状态; 使用 vercelGetDeployment 检查它.
这个 vercelDeploy 计划暴露 target,但执行不转发。 这个工具触发了生产部署,即使 preview 提供.
部署、项目创建、域名添加或去除以及环境变量写作修改远程资源。 域配置在不写入 DNS 记录的情况下返回 DNS 指令. 在添加一个域后,无法获取其DNS配置会被忽略.
设置环境变量需要非空 vars 对象。 写入使用 encrypted 作为变量类型,并尝试在 API 返回时补丁一个已存在的变量 ENV_ALREADY_EXISTS 带有可变ID. 列表返回 API 值或 (encrypted) 如果没有提供值.
域删除不检查 HTTP 响应状态 。 环境变量写入不会丢弃未处理的 HTTP 错误或失败的补丁响应,因此一个成功的工具结果不能确认这些更改已经生效.
许可证
阿帕奇 - 2.0