Skip to content

Quickstart --sync output is a wall of JSON, doesn't match the 'expected output' shown in docs #11

@nthmost-orkes

Description

@nthmost-orkes

Problem

The quickstart docs show a clean expected output for `conductor workflow start -w hello_workflow --sync`:

```json
{
"summary": "Host orkes-api-sampler-... responded in 0 ms with random value 1141",
"apiResponse": { ... }
}
```

The actual output is a ~100-line JSON blob containing full task execution details, timing, poll counts, worker IDs, etc. The workflow output values are in there (nested under `"output"`), but a new user has no way to know that — they see a wall of JSON that looks nothing like the docs.

Actual output structure

```json
{
"createTime": 1774492657451,
"output": {
"apiResponse": { ... },
"summary": "Host ... responded in 0 ms with random value 3363"
},
"requestId": "...",
"responseType": "TARGET_WORKFLOW",
"status": "COMPLETED",
"targetWorkflowId": "...",
"tasks": [ ... 80+ lines ... ]
}
```

Fix options

  1. CLI: Add a --output-only or --quiet flag to `workflow start --sync` that prints only `output` field
  2. Docs: Show the actual full output (or a truncated version with `...`) so users know what to expect
  3. CLI: Default `--sync` to printing only the workflow output, with a flag to show full details

Affects

  • `conductor-oss/conductor-cli` (UX)
  • `conductor-oss/conductor` docs/quickstart/index.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsdocs.conductor-oss.org contentfix: codeFix requires a code change in a repo

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions