安装

从 Spine v0.6.0 开始，官方入口是 CLI 的 new。安装最新发布的 CLI，创建项目并检查开发服务器的响应。

环境要求

需要 Go 1.25.5 或更高版本。CLI 推荐使用 Go 1.27.3。
Go 可执行文件的安装路径必须包含在 PATH 中。如果未设置 GOBIN，默认路径为 $(go env GOPATH)/bin。

bash

go version

确认输出的 Go 版本为 1.25.5 或更高版本。

安装 CLI

运行以下命令安装 CLI 并查看版本。

bash

go install github.com/NARUBROWN/spine-cli@latest
spine-cli version

使用 spine-cli version 确认已安装的 CLI 版本。

如果找不到 spine-cli 命令，且未单独设置 GOBIN，请在 Bash 或 Zsh 中运行以下命令，将安装路径添加到当前会话中。要持久保存此设置，请将相同配置写入 Shell 启动文件。如果已设置 GOBIN，则应添加该目录。

bash

export PATH="$(go env GOPATH)/bin:$PATH"
spine-cli version

创建新项目

在准备存放项目的父目录中运行。如果已存在同名的 my-app 目录，请使用其他名称。

bash

spine-cli new my-app --module example.com/my-app
cd my-app

new 根据已安装 CLI 的验证配方选择兼容的 Spine、Echo 平台和 Echo 版本，并完成依赖安装、静态契约检查和构建。请在生成的 go.mod 中查看所选版本。使用 --skip-install 时，请单独运行 go mod tidy 和 go mod download all。安装过程不会初始化应用、运行测试或启动监听器。

生成的 spine.toml 如下。

toml

module = "example.com/my-app"
entrypoint = "."
composition = "./internal/application"
port = 8080
layout = "layered-v1"
platform = "echo"

internal/application/application.go 中的 BuildApplication() 注册组件和 GET /health。生成的 main.go 调用此函数，通过 app.Validate(options) 验证配置后，再通过 app.Run(options) 运行服务器。

验证与运行

bash

spine-cli doctor
spine-cli inspect
spine-cli contract check
spine-cli verify

确认每条命令均执行完毕且没有错误。

命令	检查内容
`spine-cli doctor`	Go 工具和项目配置
`spine-cli inspect`	代码中注册的路由、依赖等应用配置
`spine-cli contract check`	从注册代码中提取的执行契约是否有效
`spine-cli verify`	执行契约以及 `gofmt`、`go vet` 和 Go 测试的结果

生成的 application_test.go 会检查 BuildApplication() 和 app.Validate(options)，不会启动服务器。此阶段验证的是代码和应用配置，实际 HTTP 响应将在下一步确认。

检查通过后，使用 spine-cli dev 运行服务器，并在另一个终端中确认实际 HTTP 响应。

bash

spine-cli dev

bash

curl http://localhost:8080/health

如果返回 {"status":"ok"}，则表示开发服务器已处理请求。在运行服务器的终端中按 Ctrl+C 结束运行。连接外部数据库或消息代理，或部署应用后，还需要在相应环境中确认运行情况。

后续步骤

通过第一个应用了解生成文件的作用，或按照项目结构添加功能。

安装 ​

环境要求 ​

安装 CLI ​

创建新项目 ​

验证与运行 ​

后续步骤 ​

安装

环境要求

安装 CLI

创建新项目

验证与运行

后续步骤