Skip to content

Epic: TOON + JMESPath Migration for All gh CLI Commands #133

@amondnet

Description

@amondnet

Overview

Migrate all gh CLI passthrough commands to TOON format output with JMESPath query support.

Goals

  1. Token Efficiency: TOON format provides 58.9% token reduction vs. JSON
  2. LLM-Friendly: Tab-delimited format is easier for LLMs to parse and process
  3. Powerful Filtering: JMESPath enables complex queries without external tools
  4. Consistency: All commands use the same output format and query syntax
  5. Backward Compatibility: Existing scripts continue to work

Scope

  • Total Commands: 27 command groups
  • Migration Ready: 23 commands (85%) with --json support
  • Total Timeline: 13 weeks (3 months)

Implementation Phases

Phase 1: Core Commands (P1) - 4-6 weeks

  • issue (12 subcommands)
  • pr (16 subcommands)
  • repo (13 subcommands)
  • release (8 subcommands)

Phase 2: GitHub Actions + Additional (P2) - 3-4 weeks

  • GitHub Actions: cache, run, workflow
  • Additional: api, label, ruleset, search, secret, variable, gist, org, project, codespace

Phase 3: Remaining Commands (P3) - 2-3 weeks

  • auth, browse, agent-task, alias, attestation, completion, config, extension, gpg-key, preview, ssh-key, status

Success Criteria

  • ✅ All P1 commands output TOON by default
  • ✅ JMESPath queries work on all commands
  • ✅ Field mappings complete for all view commands
  • ✅ Backward compatibility via --format table
  • ✅ 100% test coverage for new code
  • ✅ Documentation updated (EN/KO)

Documentation

Related

  • ADR 0006: TOON Format Design
  • ADR 0007: gh CLI Passthrough

Timeline

Phase 1 (Weeks 1-6): Core Commands
Phase 2 (Weeks 7-10): GitHub Actions + Additional
Phase 3 (Weeks 11-13): Remaining Commands

Dependencies

This epic tracks the complete migration. Sub-issues will be created for each phase.

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:coreCore CLI functionalityepicEpic - large feature or initiativep1Priority 1 - Hightype:featureNew feature or enhancement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions