Skip to content

tctl output format audit tracker #67108

@carrithers

Description

@carrithers

Summary

This tracking issue summarizes follow-up work from an audit of tctl command output behavior, with emphasis on Identity Governance-related commands.

The audit looked for commands where JSON/YAML support is missing, inconsistent, broken, or undocumented. The actionable findings have been split into separate issues by remediation type so each can be handled independently.

This tracking issue is not intended to be closed by a single PR.

Findings summary

The audit found four recurring output-format gaps in tctl:

  1. Some commands already emit structured output but only support one of JSON or YAML.
  2. Some commands have format support in code, but the flag is hidden or missing from generated CLI docs.
  3. Some read-only status/inventory commands expose structured data only as text tables.
  4. Some mutation commands create or update concrete resources but only print prose or a bare ID.

Scope notes

The linked issues intentionally avoid treating all tctl output the same way.

Generated artifacts such as certificates, CRLs, scripts, archives, Terraform environment output, shell snippets, and downloads are not normal JSON/YAML serialization targets.

Hidden or diagnostic commands should only be documented or expanded if they are intended to be user-facing.

Default text output should remain unchanged unless a specific child issue says otherwise.

Metadata

Metadata

Assignees

Labels

cliTickets related to CLI experiencetctltctl - Teleport admin tool

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions