Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juspay/omnix
A Nix companion to improve developer experience
https://github.com/juspay/omnix
developer-experience nix nix-flakes nixos
Last synced: 1 day ago
JSON representation
A Nix companion to improve developer experience
- Host: GitHub
- URL: https://github.com/juspay/omnix
- Owner: juspay
- License: agpl-3.0
- Created: 2023-05-27T01:08:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-13T23:34:27.000Z (5 days ago)
- Last Synced: 2025-02-14T04:34:36.490Z (5 days ago)
- Topics: developer-experience, nix, nix-flakes, nixos
- Language: Rust
- Homepage: https://omnix.page
- Size: 1.57 MB
- Stars: 141
- Watchers: 14
- Forks: 14
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://nixos.zulipchat.com/#narrow/stream/415454-omnix)
[](https://compass.naivete.me/ "This project follows the 'Naiveté Compass of Mood'")# omnix
*Pronounced [`/ɒmˈnɪks/`](http://ipa-reader.xyz/?text=%C9%92m%CB%88n%C9%AAks&voice=Geraint)*
Omnix aims to supplement the [Nix](https://nixos.asia/en/nix) CLI to improve developer experience.
## Usage
See https://omnix.page/
## Developing
1. [Install Nix](https://nixos.asia/en/install)
1. [Setup `direnv`](https://nixos.asia/en/direnv)
1. Clone this repo, `cd` to it, and run `direnv allow`.This will automatically activate the nix develop shell. Open VSCode and install recommended extensions, ensuring that direnv activates in VSCode as well.
### Running locally
To run `omnix-cli`,
```sh
just watch # Or `just w`; you can also pass args, e.g.: `just w show`
```### Nix workflows
Inside the nix develop shell (activated by direnv) you can use any of the `cargo` or `rustc` commands, as well as [`just`](https://just.systems/) workflows. Nix specific commands can also be used to work with the project:
```sh
# Full nix build of CLI
nix build .#default# Build and run the CLI
nix run
```### Contributing
>[!TIP]
> Run `just fmt` to autoformat the source tree.- Run `just ci` to **run CI locally**.
- Add **documentation** wherever useful.
- Run `just doc run` to preview website docs; edit, and run `just doc check`
- To preview Rust API docs, run `just doc cargo`.
- Changes to library crates must accompany a corresponding `CHANGELOG.md` entry.[^cc][^cc]: We don't use any automatic changelog generator for this repo.