Skip to content

jeffinity/otter

Repository files navigation

otter

Go Reference Go Version License Go Report Card Test Status codecov

otter 是一个面向开发与运维场景的 Go CLI 工具集合。当前仓库提供应用脚手架生成、Shell 补全脚本生成与安装、版本信息展示,并正在迁移服务管理能力。

主要支持平台:

  • newcompletionversion:Linux 与 macOS。
  • config-completion:仅 Linux。
  • service:仅 Linux,非 Linux 运行会直接返回不支持错误。

安装与构建

环境要求:

  • Go 1.25.5+
  • Git
  • Task

常用命令:

task check
task lint
task build
task build-linux-amd64
task build-linux-arm64
task deploy -- <host> [-f]

task deploy 默认按 checksum 跳过未变化构建,追加 -f 可强制重新构建后部署。

构建产物默认位于:

target/otter/<os>/<arch>/otter

子命令

new

基于 app-layout 模板创建新项目,支持单仓模式和大仓模式。

常用示例:

otter new github.com/acme/order order-api
otter new -m github.com/acme/mono order-api
otter new -m order-api

完整说明见 doc/new.md

service

服务管理命令入口,用于管理 otter 关注的 systemd service;该子命令仅支持 Linux。

常用形式:

otter service status
otter service start <service>
otter service log -f <service>

完整说明见 doc/service.md

completion

生成 Shell 补全脚本,支持 bashzshfishpowershell

otter completion bash
otter completion zsh

完整说明见 doc/completion.md

config-completion

在 Linux 上安装补全脚本到用户级或系统级补全目录,支持 bashzshfish

otter config-completion bash
otter config-completion --system zsh

完整说明见 doc/completion.md

version

显示当前二进制的构建信息、版本、构建时间和提交号。

otter version

开发说明

本仓库使用 AGENTS.md 约定 AI 代码变更流程、测试要求和文档同步规则。涉及顶层子命令、命令参数、flag、示例或行为变更时,必须同步更新 README 和 doc/ 下对应子命令文档;涉及核心实现设计时同步更新 design/

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages