Missing consistent return data

[kevinsteffer]

Hi,

When doing automated deployments with the tool I'm facing a problem with the data the tool returns (console.logs)

For example:
dw files -i 'C:\myfolder' 'myfolder' --recursive true --overwrite true

If this succeeds it returns text:
Uploading files
C:\myfolder\file1.cshtml
C:\myfolder\file2.cshtml
Files uploaded

If it fails I get a combination of text and invalid json

My suggesting would be that any call with the tool would return (console.log) an JSON object with at least 2 sub-objects for example in PowerShell:
$response = dw files -i 'C:\myfolder' 'myfolder' --recursive true --overwrite true
$jsonResponse = $response | Out-String | ConvertFrom-Json
$jsonResponse.json (array of the complete json responses)
$jsonResponse.data (array of the returned data)

This would make us capable of reading the json-response and see if we get 401 Unauthorized or 500 Internal Server Error or "ok"

[nicped]

We have created a new version of the CLI that supports structured output as an opt-in together with a number of other changes.

See the full pull here: #47
There is a documentation article in the pull with examples.

What's new in v2

Version 2 is an automation-first overhaul. The headline changes:

• OAuth client credentials -- the CLI can now authenticate with an OAuth 2.0 client ID and secret, removing the need for an interactive login in CI/CD pipelines and service-account scenarios.
• Structured JSON output -- every API-driven command (env, login, files, query, command) supports --output json, returning a consistent envelope with ok, status, data, errors, and meta fields. Interactive prompts are suppressed in JSON mode so output is safe to pipe.
• File delete, copy, and move -- the files command can now delete, copy, and move files and directories on the environment in addition to listing, exporting, and importing.
• Consistent error model -- commands that previously printed a message and exited silently now return structured errors (in JSON mode) or throw with a non-zero exit code. Scripts can rely on exit code 1 and the errors array for programmatic error handling.

[kevinsteffer]

Is the API driven CLI command install also supported for the --output json although it's not mentioned, it looks like it in the command.js?

[nicped]

It was not there. But it is now. Now it is only database commands that does not support it.