Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.66 KB

README.md

File metadata and controls

55 lines (35 loc) · 1.66 KB
Raw

project chat

omnix

Pronounced /ɒmˈnɪks/

Note

🚧 omnix is in active development. It aims to supplement the Nix CLI to improve developer experience.

Usage

See https://omnix.page/

Developing

  1. Install Nix
  2. Setup direnv
  3. 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,

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 workflows. Nix specific commands can also be used to work with the project:

# 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.1

Footnotes

  1. We don't use any automatic changelog generator for this repo. ↩