README.md

ghx-cli Documentation

Welcome to the ghx-cli documentation. This guide covers all features and commands of the GitHub eXtensions CLI.

Table of Contents

Getting Started

• Installation & Quick Start - Install ghx-cli and run your first commands

Command Reference

• Command Overview - All available commands at a glance
• project - Manage GitHub Projects v2
• item - Manage project items (issues, PRs, drafts)
• field - Manage custom fields
• view - Manage project views (table, board, roadmap)
• discussion - Manage GitHub Discussions
• analytics - Generate reports and bulk operations
• auth - Manage authentication

Guides

• Configuration - Configure ghx-cli settings
• Examples & Cookbook - Common use cases and workflows
• Troubleshooting - Common issues and solutions

Reference

• Feature Comparison - ghx-cli vs gh CLI capabilities
• PRD - Product Requirements Document

Quick Links

# Check authentication status
ghx auth status

# List your projects
ghx project list

# List discussions in a repository
ghx discussion list owner/repo

# Get help for any command
ghx [command] --help

Support

• GitHub Issues - Report bugs and request features
• GitHub Discussions - Ask questions and share ideas