Skip to content

Docs: cli-reference.mdx Output Formats section omits plain and the yml / markdown aliases #201

Description

@rajarshidattapy

Description

docs/cli-reference.mdx:56-62 lists five output formats: table, json, yaml, md, csv.

The supported set is eight (src/command-surface.ts:5):

export const OUTPUT_FORMATS = ['table', 'plain', 'json', 'yaml', 'yml', 'md', 'markdown', 'csv'] as const;
  • plain is implemented at src/output.ts:50 and advertised in adapter --help text at src/command-presentation.ts:87 ("Output format: table, plain, json, yaml, md, csv").
  • yml and markdown are accepted aliases for yaml and md (src/output.ts:51-55).

skills/webcmd-usage/SKILL.md:93 already documents plain ("prints the primary text field for chat-style commands"), so the agent-facing skill and the human-facing reference disagree.

Impact

plain is the right format for chat-style adapter output and is invisible to anyone reading the published reference.

Suggested fix

Add webcmd hackernews top -f plain to the example block and a line noting that yml and markdown are accepted aliases.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions