omnix

发音为 /ɒmˈnɪks/

Omnix 的目标是作为 Nix CLI 的补充，从而提升开发者的使用体验。

使用方法

参见 https://omnix.page/

开发

1. Install Nix
2. Setup direnv
3. Clone this repo, cd to it, and run direnv allow.

这将自动激活 nix develop shell。打开 VSCode 并安装推荐的扩展程序，同时确保 direnv 也能在 VSCode 中正常启动。

在本地运行

要运行 omnix-cli，

just watch # Or `just w`; you can also pass args, e.g.: `just w show`

Nix 工作流

在通过 direnv 激活的 nix develop shell 中，你可以使用任意cargo或rustc命令，以及[just工作流]。此外，还可以使用针对 Nix 的专用命令来操作该项目：

# Full nix build of CLI
nix build

# Build and run the CLI
nix run

贡献代码

[!TIP] 运行 just pca 可自动格式化源代码树。

• 运行 just ci 以在本地运行 CI。
• 在合适的位置添加文档。
  • 运行 just doc run 可预览网站文档；进行编辑后运行 just doc check
  • 要预览 Rust API 文档，请运行 just doc cargo。
• 所有的更改都必须配有对应的 history.md 条目。¹

发布指南

请从提交发布相关的 PR 开始：

• 选择一个版本
• 更新 history.md，确保包含新的发布标题
• 在 devShell 中使用所选版本运行 cargo workspace publish --force omnix-cli]。

Footnotes

1. 该仓库不使用任何自动生成变更日志的工具。 ↩