Skip to content

使用指南

eyai 的使用指南,从零开始学习如何编写和执行实验协议。

目录

指南说明
快速开始安装 CLI、编写第一个协议、验证和执行

工具链

工具说明
eyai CLI命令行工具:验证、转换、协议管理
VS Code 插件语法高亮、实时验证、智能补全
Language ServerLSP 协议支持,可集成到任意编辑器
Python EPPEPP 插件参考实现

安装 CLI

bash
# 下载单文件可执行文件(.NET AOT)
# Windows
curl -LO https://github.com/eyai-org/eyai/releases/latest/download/eyai-win-x64.exe

# macOS
curl -LO https://github.com/eyai-org/eyai/releases/latest/download/eyai-osx-x64

# Linux
curl -LO https://github.com/eyai-org/eyai/releases/latest/download/eyai-linux-x64

CLI 命令速览

命令用途
eyai init创建新协议文件
eyai validate验证协议文件
eyai convert协议格式转换
eyai spec list列出已安装规范
eyai spec install安装扩展规范

VS Code 插件

  1. 在 VS Code 扩展市场搜索 eyai
  2. 安装后打开 .eyai.yaml 文件即可获得:
    • 语法高亮
    • 实时错误提示
    • 自动补全
    • 悬停文档

eyai — 让实验协议精确、可执行、可被 AI 理解