Skip to content

feat: support reading AsyncAPI documents from stdin using "-" (#2011)#2136

Open
useye wants to merge 1 commit intoasyncapi:masterfrom
useye:feat/issue-2011-stdin-support
Open

feat: support reading AsyncAPI documents from stdin using "-" (#2011)#2136
useye wants to merge 1 commit intoasyncapi:masterfrom
useye:feat/issue-2011-stdin-support

Conversation

@useye
Copy link
Copy Markdown

@useye useye commented Apr 22, 2026

Summary

Added support for reading AsyncAPI documents from stdin by passing - as the file argument.

This follows the widely-used Unix convention where - represents stdin/stdout.

Changes

  1. Added Specification.fromStdin() method that reads from process.stdin
  2. Modified load() function to detect - as the special stdin indicator

Usage Examples

# Read from stdin
cat asyncapi.yaml | asyncapi validate -

# Generate fromTemplate with stdin input
asyncapi generate fromTemplate - @asyncapi/html-template -o out < input.yaml

# Validate with stdin
asyncapi validate - < spec.json

Error Handling

If stdin is empty, a clear error message is shown: "Not enough non-option arguments: expected at least one"

Related Issue

Fixes #2011

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 22, 2026

⚠️ No Changeset found

Latest commit: b6f4ddc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To Triage

Development

Successfully merging this pull request may close these issues.

[BUG] CLI does not support reading AsyncAPI documents from stdin (-) and fails with misleading error

1 participant