Scott

Kratos常见命令 4 months ago

go
微服务
2157个字符
共有37人围观

Kratos 提供了一系列 CLI 命令,用于快速创建、构建和运行项目。以下是一些常见的 Kratos 命令及其用途:


1. 项目初始化

  • 创建新项目
kratos new <project-name>

例如:

kratos new helloworld
  • 从模板创建项目
kratos new <project-name> -r <template-repo>

例如,使用自定义模板:

kratos new helloworld -r https://github.com/yourname/your-template-repo

2. Protobuf 相关

  • 生成客户端代码
kratos proto client <proto-file>

例如:

kratos proto client api/helloworld/v1/helloworld.proto
  • 生成服务端代码
kratos proto server <proto-file> -t <target-directory>

例如:

kratos proto server api/helloworld/v1/helloworld.proto -t internal/service
  • 生成完整的 API 代码
kratos proto all <proto-file>

例如:

kratos proto all api/helloworld/v1/helloworld.proto

3. 运行项目

  • 启动服务
kratos run

该命令会启动 HTTP 和 gRPC 服务。

  • 指定配置文件
kratos run -c <config-file>

例如:

kratos run -c configs/config.yaml

4. 构建项目

  • 构建可执行文件
kratos build

生成的可执行文件会放在 bin/ 目录下。

  • 交叉编译
kratos build --os <os> --arch <arch>

例如,编译 Linux 64 位程序:

kratos build --os linux --arch amd64

5. Docker 相关

  • 构建 Docker 镜像
kratos docker build

该命令会生成一个 Docker 镜像。

  • 运行 Docker 容器
kratos docker run

6. Kubernetes 相关

  • 生成 Kubernetes 部署文件
kratos k8s manifest
  • 部署到 Kubernetes
kratos k8s deploy

7. 工具命令

  • 清理生成的文件
kratos clean
  • 格式化代码
kratos fmt
  • 检查依赖
kratos mod tidy

8. 查看帮助

  • 查看所有命令
kratos -h
  • 查看具体命令的帮助
kratos <command> -h

例如:

kratos proto -h

9. 版本信息

  • 查看 Kratos 版本
kratos -v

10. 其他常用命令

  • 更新 Kratos CLI
go install github.com/go-kratos/kratos/cmd/kratos/v2@latest
  • 生成 Wire 依赖注入代码
kratos wire

总结

Kratos CLI 提供了丰富的命令,覆盖了从项目创建到部署的整个开发流程。熟练掌握这些命令可以显著提高开发效率。如果需要更详细的帮助,可以使用 kratos <command> -h 查看具体命令的用法。