超越工作范围
这个扩展和cli用于与"超越工作"平台的互动. 这个软件包既提供了VS代码扩展,又提供了命令行接口(CLI),用于与Beyond Workbocks合作.
VS 代码扩展
Beyond Work VS代码扩展让开发者能够直接在Visual Studio代码内编写,测试和管理工作块. 使用远程文件系统,它提供直接访问您 Beyond Workingblocks 的工具,使其成为开发者想要一个全功能编辑器来创建和更新Workbocks的理想工具.
使用量
通过 VSCode 编辑工作块 。 该扩展允许您连接到 Beyond Work 并绑定工作块到本地机器上的目录 . 这些工作空间中的工作块可以作为文件存储在您的本地机器上.
扩展有3个特性:
- 从已有的工作空间获取工作块到本地文件系统
- 从本地文件中设置工作区块
- 打开工作空间和本地文件系统之间的实时同步工作块
工作块预计将被放入一个只包含工作块的目录. 当从头开始时, 只需在某个地方创建一个新的目录 .
开始
第一步是建立新的连接. 点击 + 按钮,或使用 CMD-Shift-P 和类型 Beyond Work: Add Connection。 。 。 .
然后,输入您想要连接到的 Beyond Work 实例的主机名 。 这是您访问网络用户界面时使用的同一主机名 .
然后,点击 BEYOND 工作边栏的连接。 这将提示一个 API 密钥 。 您可以在账户设置下创建新符号来获取此功能 .
连接现在应该有一个蓝色的标记 。 在它下面,将显示一个开放编辑器的工作空间. 点击它们就可以绑入目录
选择 Choose a directory。 。 。 .
获得工作障碍
单击菜单中的工作区,选择“从工作区获取工作区”。 这把位于提供的工作空间的工作块,下载到与工作空间相关的目录上.
设置工作障碍
单击菜单中的工作空间,选择“ Store 工作区” 。 它将相关目录中的工作块文件合并为工作块定义,并将其设置在所提供的工作空间.
注意这实际上不会将工作区存储在工作区外. 为了做到这一点,打开工作区中的工作区编辑器并点击商店.
同步工作块
单击菜单中的工作空间并选择“ 允许同步 ” .
如果在UI中通过编辑器或代理更改了工作块,则该更改将反映在本地文件中. 如果本地文件被更改, 它们会被自动设置在工作空间上 。 可以在本地编辑文件的同时打开UI编辑器,编辑器会随着文件被保存而活更新.
通知工作区在设置在工作区之前会被验证。 如果工作块无效, 错误将在文件中显示 .
目录结构
工作区目录结构是这样的:
Base dir/
work_block_1/
task_1/
assets/
asset1.txt
task_1.py
manifest.yaml
CLI 工具
除了VS代码扩展外,这个软件包还提供了一个命令行接口(CLI),用于与Beyond Workbocks合作. 在单簧管里 bin/wb-cli; 其他地方将其安装为 @beyondwork/wb-cli。 。 。 .
它的主要用途是让一个编码代理(Claude Code, Codex)编写一个租户的工作区作为本地文件. 从Npm开始,接下来 工具 > Claude 代码和代码 选择 文档 在应用程序中,或打开 https://<tenant>/docs。在单曲中,参见 wb-cli/README.md (英语) 用于三种命令的用户需要,以及 bw-workblock 技术 wb-cli/技能/bw-工作街区/SKILL.md 为了代理者的行为.
平台 API
wb-cli api 曝光所有注册的WebSocket操作. 产生帮助和计划
来自与平台客户端相同的 Go 处理器定义: 每个请求生成的条目
API schema带有它的描述,主题,表面和实例. clone, (中文(简体) ), push, (中文(简体) ), run 以及其它问题
命令仍然是管理本地退出状态的工作流程.
wb-cli api # Studio topics
wb-cli api --list --group permissions
wb-cli api --all --search schedule
wb-cli api permissions_grant --help
wb-cli api permissions_grant --describe # complete JSON schemas
wb-cli api <operation> '<json>' --tenant <host>
cat request.json | wb-cli api <operation> - --tenant <host>
发现默认为工作室. --surface spaces, (中文(简体) ), --surface admin,以及 --all 揭露其他领域;
无论发现的视角如何,所有操作仍然可以调用。 呼叫使用您已有的登录
或 API 令牌,服务器执行权限和呼叫限制. HTTP 认证,
blob 传输和浏览器重定向仍然独立于 WebSocket API.
帮助来自于这个wb-cli的API计划. 服务器验证每个请求 .
这个Wb-cli不知道的操作仍然被发送;在它发送一个之前,Wb-cli读到:
租户的警告 help。如果无法提供或未列出帮助,则
操作, wb- cli 需要 --yes 在一个人确认其效果后.
一些行动部署到 main,发布,合并,删除数据,更改访问,或终止一个
工作流程。 他们 --help 从警告开始。 无 --yes,CLI不发送这样的
操作 : 它在 Stderr 上将警告打印为 JSON, 并用代码 3 退出 。 过 --yes 仅在 a 之后
当事人确认警告.
在一次退票中,当业务使用时,电话会继承其租户及其流动。 覆盖
他们与 --tenant, (中文(简体) ), --stream,或 --no-stream。原始调用不更新退出文件或
标记。 调用打印出 JSON 的 stdout; 在 stderr 上的 JSON 对象中错误保留服务器代码 .
--timeout 将请求的最后期限设定为秒.
从目录中集合一个工作块
wb-cli assemble /path/to/workblock/dir [--output output.json]
此命令需要包含工作块文件的目录,并将其组装为完整的工作块JSON对象. 结构采用 " 超越工作 " 格式:
Base dir/
work_block_1/
task_1/
assets/
asset1.txt
task_1.py
manifest.yaml
import, (中文(简体) ), export, (中文(简体) ), submit, (中文(简体) ), publish-changed-workblocks 财务报告和审定财务报表 list-changed-workblocks 用于CI管道和一次性转让;见 wb-cli --help。 。 。 .
程序用途
您也可以在程序上使用库:
import { assembleWorkblock, storeWorkblockFiles } from "beyondwork/lib/utils";
// Assemble a workblock from files
const workblock = await assembleWorkblock("/path/to/workblock");
// Store a workblock as files
await storeWorkblockFiles("/output/path", workblockObject);