Redocly / Redocly/redocly-cli

Add verbose mode

Open
#1,128 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

p3 Type: Enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Is your feature request related to a problem? Please describe.

Redocly CLI shows nice error messages for handled exceptions. For unhandled exceptions error stacktrace is shown. We can also show a nice error message in Terminal for this kind of exceptions and show the stacktrace only with --verbose option.

Describe the solution you'd like

Add --verbose flag to all commands and show error details only if it is provided.

Describe alternatives you've considered

Doing nothing. Current approach is very much ok.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the CLI command definitions and the existing handling for unhandled exceptions. Trace how options are registered across commands, then verify that normal terminal messages omit stack traces and --verbose retains error details for every command.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.