omnix-cli MVP roadmap

[srid]

omnix-cli will be a "super CLI" for Nix of some sort. Where possible, we will expose the functionality as Rust libraries (which can be used by other clients, like omnix-gui).

To begin with, we will have omnix-cli to do two things:

Initialize flakes

om init

This should support a registry of flake templates (use our various flake-parts modules), initialize them using nix flake init as well as fill in any user-specific content using the templateGenerators idea in flake-parts/templates#7 (comment)

The goal is to have om init create flakes for any kind of stack, eventually.

See #152

Inspect flakes

Warning

To be fleshed out.

om show

On a flakified project, display a "dynamic README" of some sort that tells any product-oriented person as to how to interact with it. Eg. build the project or run it. If there are services, tell how to run these services. The 'metadata' for this should be standardized somehow. At a basic level, meta.description can be used to describe derivations (including devShells); how do we want to describe, for example, services?

Note

om show should also show a status indicator for om health (which runs https://github.com/juspay/nix-health)

---

Progress

• Prepare
  • Use cargo workspaces #137
  • chore: Rename project to omnix #138
  • Initialize omnix-cli crate #144
  • Create omnix library crate #146
  • omnix-cli: Initialize CLI argument handling #148
• Features
  • Basic om show #147
  • om init - for smart template generation #152
  • om health (Health checks) #150
  • Add om ci #179
• Niceties
  • omnix-cli: Add autocompletion #56
  • Static binary for omnix-cli #149
  • Website & Documentation #178
  • om ci #151

[srid]

Due to #154, it should be fairly straightforward to do #150, so I've added it to the MVP.

[srid]

We are fairly close to making a release. Needs polish, docs, and other niceties (esp. #166).

[srid]

0.1.0 was released; so will close this.

https://github.com/juspay/omnix/releases/tag/0.1.0

https://omnix.page/