Skip to content

[Code Quality] Improve logs command help text scannability #12891

@github-actions

Description

@github-actions

Description

The logs command help text is comprehensive (~80 lines) but difficult to scan for specific information. Users must read through the entire text to find relevant details about usage patterns, artifacts, or examples.

Problem

Current Experience: The help text presents all information in a continuous block without clear visual hierarchy:

  • No separation between basic usage, advanced patterns, and examples
  • Difficult to distinguish conceptual information from practical commands
  • High cognitive load for a frequently-referenced command
  • Important features may be overlooked

Impact: Developers spend extra time finding relevant information when debugging or analyzing workflows.

Suggested Changes

Restructure the Long description in pkg/cli/logs_command.go with clear section headers:

Long: `Download workflow run logs and artifacts from GitHub Actions for agentic workflows.

BASIC USAGE
  Downloads workflow runs with artifacts and generates an overview table with aggregate
  metrics (duration, token usage, cost). Artifacts are organized by run ID.

DOWNLOADED ARTIFACTS
  - aw_info.json: Engine configuration and workflow metadata
  - safe_output.jsonl: Agent's final output (when non-empty)
  - agent_output/: Agent logs directory
  - agent-stdio.log: Standard output/error logs
  - aw.patch: Git patch of changes
  - workflow-logs/: GitHub Actions job logs
  - summary.json: Complete metrics for all runs

CAMPAIGN ORCHESTRATOR USAGE
  Pre-download logs in a workflow step, then reference the data:
  [step examples...]

EXAMPLES
  # Basic Usage
  ` + string(constants.CLIExtensionPrefix) + ` logs                    # All workflows
  ...

Files Affected

  • pkg/cli/logs_command.go (lines 33-111)

Success Criteria

  • Help text organized into scannable sections with UPPERCASE headers
  • Blank lines separate major sections
  • Information grouped logically (basic → artifacts → advanced → examples)
  • Reduces time to find relevant information by 50%+
  • All existing content preserved, only restructured

Source

Extracted from User Experience Analysis discussion #12888

Priority

High - Improves efficiency for frequently-used command during debugging and workflow analysis

Estimated Effort

30-45 minutes

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 14, 2026, 9:08 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions