@bretwardjames/ghp-core 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +123 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# GHP Tools
|
|
2
|
+
|
|
3
|
+
A suite of tools for managing GitHub Projects from your terminal and editor.
|
|
4
|
+
|
|
5
|
+
## What's Included
|
|
6
|
+
|
|
7
|
+
| Package | Description |
|
|
8
|
+
|---------|-------------|
|
|
9
|
+
| **[@bretwardjames/ghp-cli](https://github.com/bretwardjames/ghp-cli)** | Command-line interface for GitHub Projects |
|
|
10
|
+
| **[vscode-gh-projects](https://github.com/bretwardjames/vscode-gh-projects)** | VS Code / Cursor extension with visual boards |
|
|
11
|
+
| **@bretwardjames/ghp-core** | Shared library (this package) |
|
|
12
|
+
|
|
13
|
+
Both the CLI and extension share the same underlying library and are designed to work together.
|
|
14
|
+
|
|
15
|
+
## Quick Install
|
|
16
|
+
|
|
17
|
+
Install both the CLI and VS Code/Cursor extension with a single command:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
curl -fsSL https://raw.githubusercontent.com/bretwardjames/ghp-core/main/install.sh | bash
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
This will:
|
|
24
|
+
1. Install the `ghp` CLI globally via npm
|
|
25
|
+
2. Install the VS Code/Cursor extension from the latest release
|
|
26
|
+
|
|
27
|
+
### Manual Installation
|
|
28
|
+
|
|
29
|
+
**CLI only:**
|
|
30
|
+
```bash
|
|
31
|
+
npm install -g @bretwardjames/ghp-cli
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
**Extension only:**
|
|
35
|
+
Download the `.vsix` from [releases](https://github.com/bretwardjames/vscode-gh-projects/releases) and install:
|
|
36
|
+
```bash
|
|
37
|
+
code --install-extension gh-projects-*.vsix
|
|
38
|
+
# or for Cursor:
|
|
39
|
+
cursor --install-extension gh-projects-*.vsix
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Getting Started
|
|
43
|
+
|
|
44
|
+
1. Authenticate with GitHub:
|
|
45
|
+
```bash
|
|
46
|
+
ghp auth
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
2. View your assigned work:
|
|
50
|
+
```bash
|
|
51
|
+
ghp work
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
3. Open VS Code/Cursor and find the GitHub Projects panel in the sidebar
|
|
55
|
+
|
|
56
|
+
## Features
|
|
57
|
+
|
|
58
|
+
### Shared Across Both Tools
|
|
59
|
+
|
|
60
|
+
- **Branch Linking** - Link branches to issues, track which issues have active work
|
|
61
|
+
- **Workflow Automation** - "Start Working" creates branches and updates status
|
|
62
|
+
- **Project Board Views** - See your boards exactly as configured on GitHub
|
|
63
|
+
- **Issue Templates** - Create issues using your repo's templates
|
|
64
|
+
|
|
65
|
+
### CLI-Specific
|
|
66
|
+
|
|
67
|
+
- **Shortcuts** - Define named filter combinations (`ghp plan bugs`)
|
|
68
|
+
- **Slice Filters** - Filter by any field (`--slice Priority=High`)
|
|
69
|
+
- **Workspace Config** - Share settings with your team via `.ghp/config.json`
|
|
70
|
+
- **Simple List Output** - Integration with fzf, rofi, and other pickers
|
|
71
|
+
|
|
72
|
+
### Extension-Specific
|
|
73
|
+
|
|
74
|
+
- **Drag and Drop** - Move issues between columns visually
|
|
75
|
+
- **Planning Board** - Full-screen kanban view
|
|
76
|
+
- **Multi-Select** - Bulk operations on multiple items
|
|
77
|
+
- **Real-Time Sync** - Stay in sync with GitHub
|
|
78
|
+
|
|
79
|
+
## Configuration
|
|
80
|
+
|
|
81
|
+
Both tools share the same configuration concepts. The CLI uses JSON files, the extension uses VS Code settings.
|
|
82
|
+
|
|
83
|
+
### CLI Configuration (ghp-cli)
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
# View all settings with their sources
|
|
87
|
+
ghp config --show
|
|
88
|
+
|
|
89
|
+
# Edit user config (opens $EDITOR)
|
|
90
|
+
ghp config
|
|
91
|
+
|
|
92
|
+
# Edit workspace config (shared with team)
|
|
93
|
+
ghp config -w
|
|
94
|
+
|
|
95
|
+
# Set individual value
|
|
96
|
+
ghp config mainBranch develop
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
**Config files:**
|
|
100
|
+
- User: `~/.config/ghp-cli/config.json` (personal overrides)
|
|
101
|
+
- Workspace: `.ghp/config.json` (committed, shared with team)
|
|
102
|
+
|
|
103
|
+
Merge order: defaults -> workspace -> user
|
|
104
|
+
|
|
105
|
+
### Extension Configuration (VS Code)
|
|
106
|
+
|
|
107
|
+
Settings are in VS Code's settings UI under "GitHub Projects", or in your workspace `.vscode/settings.json`.
|
|
108
|
+
|
|
109
|
+
## Links
|
|
110
|
+
|
|
111
|
+
- [ghp-cli Documentation](https://github.com/bretwardjames/ghp-cli)
|
|
112
|
+
- [VS Code Extension Documentation](https://github.com/bretwardjames/vscode-gh-projects)
|
|
113
|
+
- [Report Issues](https://github.com/bretwardjames/ghp-core/issues)
|
|
114
|
+
|
|
115
|
+
## Requirements
|
|
116
|
+
|
|
117
|
+
- Node.js >= 18
|
|
118
|
+
- GitHub account with Projects access
|
|
119
|
+
- VS Code 1.85+ or Cursor (for extension)
|
|
120
|
+
|
|
121
|
+
## License
|
|
122
|
+
|
|
123
|
+
MIT
|