CTS / example

ok-envelope.json

Inspect a structured JSON success response.

DownloadView source file Read related standard

Useful when

My CLI interface is inconsistent.

Choose your situation

What you should change

Replace tool identity and data; preserve only envelope fields your consumers need.

Use only the parts that help. These are starting points, not rigid requirements.

View resource

{
  "status": "ok",
  "tool": "example-command",
  "version": "1.0.0",
  "data": {
    "message": "Completed successfully.",
    "items_count": 1
  },
  "warnings": [],
  "errors": []
}

Related resources

CTS / template / Quick win

Command-Contract.md

Define arguments, output streams, exit codes and command behavior.

View & adapt Download

CTS / checklist / Quick win

CLI-Release-Checklist.md

Review a CLI release for predictable behavior and evidence.

View & adapt Download

CTS / example / Quick win

error-envelope.json

Inspect a structured JSON error response.

View & adapt Download