bdbch.com
oxrls#
A Rust-powered release CLI for JS/TS monorepos — version bumps, changelogs, pre-release mode, and npm publishing.
Packages#
This project contains two components:
| Component | Description |
|---|---|
NAPI addon (vp_release) |
Native Node.js addon built with napi-rs |
CLI (oxrls) |
Rust binary for release management |
Quick start#
# Initialize
oxrls init
# Create a release file
oxrls new --package @scope/core:patch --summary "Fix transaction mapping bug"
# Preview
oxrls status
oxrls bump --dry-run
# Apply
oxrls bump
# Publish to npm
oxrls release
Commands#
| Command | Description |
|---|---|
oxrls init |
Create oxrls.json config and .oxrls/ directory |
oxrls new |
Create a release file (interactive or --package --summary) |
oxrls status |
Show pending release files and calculated bumps |
oxrls bump |
Apply version bumps, update deps, generate changelogs |
oxrls release |
Publish bumped packages to npm |
oxrls pre |
Manage pre-release mode (interactive or enter/exit) |
Documentation#
See the docs/ directory:
- Getting Started — installation, quick start, workflow
- Configuration — all config options (changelog, pre-mode, fixed/linked groups)
- Usage — full command reference, release files, version rules, internals
Build#
cargo build --release
# binary at target/release/oxrls
NAPI Addon#
The NAPI addon provides native Rust bindings for Node.js:
yarn build
yarn test