Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
CLI Usage
✓ npm install -g asyncapi-bundler-cli
asyncapi-bundler-cli input.yaml > output.json
This package is a CLI and is used directly from the command line, not imported programmatically. For programmatic bundling, use the `@asyncapi/bundler` library.
bundle (from @asyncapi/bundler)
✓ import { bundle } from '@asyncapi/bundler';
✗ const bundle = require('asyncapi-bundler-cli');
This is for the underlying library `@asyncapi/bundler`, which provides programmatic access to bundling. This CLI package (`asyncapi-bundler-cli`) is not intended for direct programmatic import.
AsyncAPIBundlerOptions (from @asyncapi/bundler)
✓ import type { AsyncAPIBundlerOptions } from '@asyncapi/bundler';
This is a type import for programmatic use of the underlying `@asyncapi/bundler` library, not for this CLI. For TypeScript projects integrating bundling logic.
Demonstrates global installation and basic usage of the CLI to bundle AsyncAPI documents from YAML/JSON files.
npm install -g asyncapi-bundler-cli
# Bundle a single AsyncAPI file and output to JSON
asyncapi-bundler-cli ./path/to/asyncapi.yaml > output.json
# Bundle multiple AsyncAPI files (example of complex usage, specific options may vary by version)
# Note: Refer to asyncapi/bundler documentation for exact options like baseDir if needed.
asyncapi-bundler-cli --baseDir . spec/main.yaml spec/channels.yaml spec/messages.yaml > bundled-api.yaml
asyncapi-bundler --version
Debug
Known issues
breakingThe underlying `@asyncapi/bundler` library (which this CLI relies on) was subject to a critical supply chain attack (GMS-2025-693) on November 24th, 2025. This involved malicious code attempting to harvest credentials and infect repositories during the pre-install phase. All users are strongly advised to rotate credentials, clear npm caches, remove `node_modules`, and roll back dependencies to a safe version or, preferably, migrate to the official `@asyncapi/cli`.fixImmediately migrate to `@asyncapi/cli` (latest stable version). If direct use of `@asyncapi/bundler` is required, consult its npm page for safe versions and vulnerability mitigations. Review all system credentials.
affects: All versions depending on compromised `@asyncapi/bundler` versions.
deprecatedThis standalone CLI (`asyncapi-bundler-cli`) is largely superseded by the official and actively maintained `@asyncapi/cli` package, which includes a `bundle` command. The official CLI offers broader functionality and more consistent updates.fixMigrate to `@asyncapi/cli` by installing it globally (`npm install -g @asyncapi/cli`) and using `asyncapi bundle` as a subcommand.
affects: >=0.7.1
gotchaBundling AsyncAPI v3 documents might not be fully supported, leading to errors. The underlying `@asyncapi/bundler` library has had ongoing efforts for v3 support, and older versions (which this CLI might use) may explicitly fail.fixIf working with AsyncAPI v3, use the latest `@asyncapi/cli` and verify its v3 bundling capabilities, or programmatically use the latest `@asyncapi/bundler` library, checking its release notes for v3 compatibility.
affects: <=0.7.1
gotchaAs a 0.x version package, `asyncapi-bundler-cli` may introduce breaking changes between minor versions without adhering strictly to semantic versioning. Always review release notes when upgrading.fixPin to exact versions in `package.json` or use a version range that minimizes unexpected changes (e.g., `~0.7.0` instead of `^0.7.0`). Consider migrating to `@asyncapi/cli` for more stable versioning.
affects: >=0.0.0
Errors
Common errors & fixes
command not found: asyncapi-bundler-cli
The CLI executable is not in your system's PATH, typically because it wasn't installed globally or `npm`'s global bin directory isn't configured correctly.
fixEnsure the package is installed globally: `npm install -g asyncapi-bundler-cli`. If the problem persists, check your npm global installation path and ensure it's included in your system's PATH environment variable.
Error: One of the files you tried to bundle is AsyncAPI v3 format, the bundle command does not support it yet, please checkout https://github.com/asyncapi/bundler/issues/133
The version of the bundler used by this CLI does not support the AsyncAPI Specification v3.0 format.
fixDowngrade your AsyncAPI specification to v2.x or migrate to the latest official `@asyncapi/cli` which is more likely to have (or is actively developing) AsyncAPI v3 support for bundling.
YAMLParseError: bad indentation of a mapping entry
The input AsyncAPI YAML file contains syntax errors, specifically incorrect indentation or invalid YAML structure.
fixUse a YAML linter or editor with YAML validation (e.g., VS Code with YAML extension) to correct the syntax errors in your AsyncAPI definition files.
Audit
Dependencies
@asyncapi/bundlerrequiredProvides the core logic for bundling AsyncAPI documents, which this CLI wraps.