juspay/omnix
1
1
Fork 0
mirror of https://github.com/juspay/omnix.git synced 2024-11-28 01:16:59 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
🚧 A Nix wrapper to improve developer experience
699 Commits 25 Branches 1 Tag 19 MiB
Rust 90%
Nix 9.3%
Just 0.3%
JavaScript 0.2%
Shell 0.2%
main
Go to file
David Chocholatý af87950a43
Some checks failed
CI / main (${{ contains(github.ref, 'main') }}, aarch64-darwin) (push) Has been cancelled
Details
CI / main (${{ contains(github.ref, 'main') }}, aarch64-linux) (push) Has been cancelled
Details
CI / main (${{ contains(github.ref, 'main') }}, x86_64-darwin) (push) Has been cancelled
Details
CI / main (${{ contains(github.ref, 'main') }}, x86_64-linux) (push) Has been cancelled
Details
CI / website (push) Has been cancelled
Details
CI / static-binary-check (macos-latest) (push) Has been cancelled
Details
CI / static-binary-check (ubuntu-latest) (push) Has been cancelled
Details
om health: Improve tracing message for flake URL
2024-11-17 19:53:02 -05:00
.github/workflows ci: Use the new cachix-push leveraging omci.json 2024-11-06 15:27:01 -05:00
.vscode vscode: Add dependi 2024-07-14 13:47:00 -04:00
crates om health: Improve tracing message for flake URL 2024-11-17 19:53:02 -05:00
doc Read configuration once only (#341) 2024-11-14 12:18:35 -05:00
nix nix: Remove cargo-doc-live 2024-10-26 14:19:06 -04:00
.envrc omnixrc: Support no-args case 2024-10-24 12:02:12 -04:00
.gitattributes chore: Fix .gitattributes path 2024-07-12 23:17:51 -04:00
.gitignore nix/doc: Decompose the flake 2024-08-07 15:54:45 -04:00
bacon.toml rename: om hack -> om develop 2024-10-25 16:40:48 -04:00
Cargo.lock Read configuration once only (#341) 2024-11-14 12:18:35 -05:00
Cargo.toml rename: omnix-hack -> omnix-develop 2024-10-25 16:40:48 -04:00
flake.lock nix: Update rust-flake (back on 'main') 2024-11-04 22:50:00 -05:00
flake.nix nix: Update rust-flake (back on 'main') 2024-11-04 22:50:00 -05:00
justfile ci: Run tests in release mode 2024-10-26 09:55:49 -04:00
LICENSE Fix LICENSE to match cargo meta 2023-11-30 12:43:23 -05:00
omnixrc omnixrc: Use 'develop' 2024-10-28 20:35:05 -04:00
README.md readme: Remove outdated stuff 2024-10-14 18:29:55 -04:00
rust-toolchain.toml Fix build on aarch64-linux; Build for aarch64-linux in CI (#308) 2024-10-11 17:37:53 -04:00

README.md

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

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