redis-smq-rest-api 9.0.0-next.0 → 9.0.0-next.2

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [9.0.0-next.2](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.1...v9.0.0-next.2) (2025-09-07)
+
+### 🐛 Bug Fixes
+
+- **redis-smq-rest-api:** add shebang to CLI script for proper execution ([1ed36cc](https://github.com/weyoss/redis-smq/commit/1ed36cc76c0c8dce97a6f99c0b082bec34d3853d))
+- **redis-smq-rest-api:** set default Redis database to 0 ([7e12b43](https://github.com/weyoss/redis-smq/commit/7e12b433c7d4f88bc3a443505818da6a479202a3))
+
+### 📝 Documentation
+
+- **redis-smq-rest-api:** remove outdated prerequisites section ([f14aaaf](https://github.com/weyoss/redis-smq/commit/f14aaaf0da96e43468ead3e845ebd2be7e61ae59))
+- update installation instructions to include required deps ([107c2a5](https://github.com/weyoss/redis-smq/commit/107c2a5b2eda5b540f5f033808be94923e8688fa))
+
+## [9.0.0-next.1](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.0...v9.0.0-next.1) (2025-09-06)
+
+### 📝 Documentation
+
+- **redis-smq-rest-api:** add CLI usage documentation and examples ([c51cf48](https://github.com/weyoss/redis-smq/commit/c51cf4860ba556ce72b42472289f1bc8b69a3647))
+
 ## [9.0.0-next.0](https://github.com/weyoss/redis-smq/compare/v8.3.1...v9.0.0-next.0) (2025-09-06)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -14,22 +14,11 @@ queue using a RESTful API.
 - 🧪 90%+ code coverage with extensive testing
 - 📦 Support for both ESM & CJS modules
 
-
-## Prerequisites
-
-- [RedisSMQ V8](https://github.com/weyoss/redis-smq) latest release.
-
 ## Installation
 
 ```bash
 # Using npm
-npm install redis-smq-rest-api --save
-
-# Using yarn
-yarn add redis-smq-rest-api
-
-# Using pnpm
-pnpm add redis-smq-rest-api
+npm install redis-smq redis-smq-common redis-smq-rest-api --save
 ```
 
 ## Version Compatibility
@@ -81,7 +70,7 @@ const basicConfig: IRedisSMQHttpApiConfig = {
 };
 ```
 
-## Usage
+## Programmatic Usage
 
 ```typescript
 import { RedisSmqRestApi } from 'redis-smq-rest-api';
@@ -104,6 +93,35 @@ const apiServer = new RedisSmqRestApi(config);
 apiServer.run();
 ```
 
+## Usage from CLI
+
+The REST API server can be started directly from your terminal after installation.
+
+```shell
+npx redis-smq-rest-api
+```
+
+### CLI Options
+
+You can override the default configuration using the following command-line arguments:
+
+```shell
+-p, --port <port>             Port to run the API server on (default: "7210")
+-B, --base-path <basePath>    Base public path for the Swagger UI (default: "/")
+-H, --redis-host <redisHost>  Redis server host (default: "127.0.0.1")
+-P, --redis-port <redisPort>  Redis server port (default: "6379")
+-D, --redis-db <redisDB>      Redis database number (default: "0")
+-h, --help                    display help for command
+```
+
+### CLI Examples
+
+Starting the server on a specific port and connecting to a different Redis instance:
+
+```shell
+npx redis-smq-rest-api --port 8000 --redis-host 10.0.0.5 --redis-port 6380
+```
+
 ## API Documentation
 
 ### Swagger UI

package/dist/cjs/src/config/parseConfig.js

@@ -27,7 +27,7 @@ exports.defaultConfig = {
         options: {
             host: '127.0.0.1',
             port: 6379,
-            db: 1,
+            db: 0,
         },
     },
     apiServer: {

package/dist/esm/bin/cli.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import { Command } from 'commander';
 import { RedisSMQRestApi } from '../src/index.js';
 import { defaultConfig } from '../src/config/parseConfig.js';

package/dist/esm/src/config/parseConfig.js

@@ -12,7 +12,7 @@ export const defaultConfig = {
         options: {
             host: '127.0.0.1',
             port: 6379,
-            db: 1,
+            db: 0,
         },
     },
     apiServer: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq-rest-api",
-  "version": "9.0.0-next.0",
+  "version": "9.0.0-next.2",
   "description": "REST API for RedisSMQ: OpenAPI 3 schema and Swagger UI for managing queues, messages, and consumers.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",
@@ -66,8 +66,8 @@
     "uuid": "11.1.0"
   },
   "peerDependencies": {
-    "redis-smq": "^9.0.0-next.0",
-    "redis-smq-common": "^9.0.0-next.0"
+    "redis-smq": "^9.0.0-next.2",
+    "redis-smq-common": "^9.0.0-next.2"
   },
   "devDependencies": {
     "@types/json-schema": "7.0.15",