Skip to content

Commit e4aef50

Browse files
serithemageclaude
andcommitted
docs: add comprehensive user documentation
Added documentation covering all ghx-cli features: - docs/README.md: Documentation index - docs/getting-started.md: Installation and quick start guide - docs/configuration.md: Configuration options - docs/troubleshooting.md: Common issues and solutions - docs/examples.md: Cookbook with workflows and scripts Command references: - docs/commands/README.md: Command overview - docs/commands/project.md: Project management - docs/commands/item.md: Item management - docs/commands/field.md: Field management - docs/commands/view.md: View management - docs/commands/discussion.md: Discussion management - docs/commands/analytics.md: Analytics and bulk operations - docs/commands/auth.md: Authentication Partially addresses #15 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 54aa133 commit e4aef50

14 files changed

Lines changed: 3128 additions & 10 deletions

docs/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# ghx-cli Documentation
2+
3+
Welcome to the ghx-cli documentation. This guide covers all features and commands of the GitHub eXtensions CLI.
4+
5+
## Table of Contents
6+
7+
### Getting Started
8+
- [Installation & Quick Start](getting-started.md) - Install ghx-cli and run your first commands
9+
10+
### Command Reference
11+
- [Command Overview](commands/README.md) - All available commands at a glance
12+
- [project](commands/project.md) - Manage GitHub Projects v2
13+
- [item](commands/item.md) - Manage project items (issues, PRs, drafts)
14+
- [field](commands/field.md) - Manage custom fields
15+
- [view](commands/view.md) - Manage project views (table, board, roadmap)
16+
- [discussion](commands/discussion.md) - Manage GitHub Discussions
17+
- [analytics](commands/analytics.md) - Generate reports and bulk operations
18+
- [auth](commands/auth.md) - Manage authentication
19+
20+
### Guides
21+
- [Configuration](configuration.md) - Configure ghx-cli settings
22+
- [Examples & Cookbook](examples.md) - Common use cases and workflows
23+
- [Troubleshooting](troubleshooting.md) - Common issues and solutions
24+
25+
### Reference
26+
- [Feature Comparison](feature-comparison.md) - ghx-cli vs gh CLI capabilities
27+
- [PRD](PRD.md) - Product Requirements Document
28+
29+
## Quick Links
30+
31+
```bash
32+
# Check authentication status
33+
ghx auth status
34+
35+
# List your projects
36+
ghx project list
37+
38+
# List discussions in a repository
39+
ghx discussion list owner/repo
40+
41+
# Get help for any command
42+
ghx [command] --help
43+
```
44+
45+
## Support
46+
47+
- [GitHub Issues](https://github.com/roboco-io/ghx-cli/issues) - Report bugs and request features
48+
- [GitHub Discussions](https://github.com/roboco-io/ghx-cli/discussions) - Ask questions and share ideas

docs/commands/README.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Command Reference
2+
3+
ghx-cli provides commands organized into logical groups for managing GitHub Projects and Discussions.
4+
5+
## Command Groups
6+
7+
| Command | Description |
8+
|---------|-------------|
9+
| [ghx project](project.md) | Manage GitHub Projects v2 |
10+
| [ghx item](item.md) | Manage project items (issues, PRs, drafts) |
11+
| [ghx field](field.md) | Manage custom fields |
12+
| [ghx view](view.md) | Manage project views |
13+
| [ghx discussion](discussion.md) | Manage GitHub Discussions |
14+
| [ghx analytics](analytics.md) | Generate reports and bulk operations |
15+
| [ghx auth](auth.md) | Manage authentication |
16+
17+
## Global Flags
18+
19+
These flags are available for all commands:
20+
21+
| Flag | Description | Default |
22+
|------|-------------|---------|
23+
| `--config` | Config file path | `$HOME/.ghx.yaml` |
24+
| `--token` | GitHub Personal Access Token | - |
25+
| `--org` | GitHub organization | - |
26+
| `--user` | GitHub user | - |
27+
| `--format` | Output format (table, json, yaml) | `table` |
28+
| `--debug` | Enable debug output | `false` |
29+
| `--no-cache` | Disable caching | `false` |
30+
| `-h, --help` | Help for command | - |
31+
| `-v, --version` | Version information | - |
32+
33+
## Command Structure
34+
35+
Commands follow this pattern:
36+
37+
```
38+
ghx <group> <action> [arguments] [flags]
39+
```
40+
41+
Examples:
42+
```bash
43+
ghx project list # List projects
44+
ghx project view myorg/123 # View specific project
45+
ghx item add myorg/123 repo#42 # Add item to project
46+
ghx discussion create owner/repo # Create discussion
47+
```
48+
49+
## Output Formats
50+
51+
### Table (Default)
52+
53+
Human-readable table format:
54+
55+
```bash
56+
ghx project list
57+
```
58+
59+
```
60+
NUMBER TITLE ITEMS UPDATED
61+
1 Sprint 1 42 2024-01-15
62+
2 Backlog 128 2024-01-14
63+
```
64+
65+
### JSON
66+
67+
Machine-readable JSON format:
68+
69+
```bash
70+
ghx project list --format json
71+
```
72+
73+
```json
74+
[
75+
{"number": 1, "title": "Sprint 1", "items": 42},
76+
{"number": 2, "title": "Backlog", "items": 128}
77+
]
78+
```
79+
80+
### YAML
81+
82+
YAML format for configuration files:
83+
84+
```bash
85+
ghx project list --format yaml
86+
```
87+
88+
```yaml
89+
- number: 1
90+
title: Sprint 1
91+
items: 42
92+
- number: 2
93+
title: Backlog
94+
items: 128
95+
```
96+
97+
## Exit Codes
98+
99+
| Code | Meaning |
100+
|------|---------|
101+
| 0 | Success |
102+
| 1 | General error |
103+
| 2 | Invalid arguments |
104+
| 3 | Authentication error |
105+
| 4 | API error |
106+
107+
## Getting Help
108+
109+
```bash
110+
# General help
111+
ghx --help
112+
113+
# Group help
114+
ghx project --help
115+
116+
# Command help
117+
ghx project create --help
118+
```

0 commit comments

Comments
 (0)