get-shit-pretty 0.4.2 → 0.4.3
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 +121 -116
- package/VERSION +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,9 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# GET SHIT PRETTY
|
|
4
4
|
|
|
5
|
-
**Design engineering for AI coding tools.**
|
|
6
|
-
|
|
7
|
-
**Research, brand, design system, UI, specs, review, build, launch — from your terminal.**
|
|
5
|
+
**Design engineering system for AI coding tools.**
|
|
8
6
|
|
|
9
7
|
[](https://www.npmjs.com/package/get-shit-pretty)
|
|
10
8
|
[](https://www.npmjs.com/package/get-shit-pretty)
|
|
@@ -21,11 +19,13 @@ npx get-shit-pretty
|
|
|
21
19
|
|
|
22
20
|
<br>
|
|
23
21
|
|
|
24
|
-
*"
|
|
22
|
+
*"GSD gets shit done. GSP gets shit pretty."*
|
|
23
|
+
|
|
24
|
+
*Brief to build. In your terminal.*
|
|
25
25
|
|
|
26
26
|
<br>
|
|
27
27
|
|
|
28
|
-
[Why GSP Exists](#why-gsp-exists) · [How It Works](#how-it-works) · [Commands](#commands) · [Agents
|
|
28
|
+
[Why GSP Exists](#why-gsp-exists) · [How It Works](#how-it-works) · [Branding Diamond](#-diamond-1--branding) · [Project Diamond](#-diamond-2--project) · [Commands](#commands) · [Agents](#agents) · [AI Tool Support](#ai-coding-tool-support)
|
|
29
29
|
|
|
30
30
|
</div>
|
|
31
31
|
|
|
@@ -55,185 +55,190 @@ The missing half of the bridge.
|
|
|
55
55
|
|
|
56
56
|
## How It Works
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
GSP follows a **dual-diamond** architecture — two complete design cycles that take you from nothing to shipped.
|
|
59
59
|
|
|
60
60
|
```
|
|
61
|
-
/gsp:start
|
|
61
|
+
/gsp:start → picks up where you left off, routes you forward
|
|
62
|
+
|
|
63
|
+
◆ Diamond 1 — Branding ◆ Diamond 2 — Project
|
|
64
|
+
┌──────────────────────────┐ ┌──────────────────────────────┐
|
|
65
|
+
│ brand-research │ │ project-brief │
|
|
66
|
+
│ ↓ │ │ ↓ │
|
|
67
|
+
│ brand-strategy │ │ project-research │
|
|
68
|
+
│ ↓ │ │ ↓ │
|
|
69
|
+
│ brand-verbal │ │ project-design │
|
|
70
|
+
│ ↓ │ │ ↓ │
|
|
71
|
+
│ brand-identity │ │ project-critique ←──┐ │
|
|
72
|
+
│ ↓ │ │ ↓ loop │ │
|
|
73
|
+
│ brand-patterns │ │ project-build │ │
|
|
74
|
+
└──────────────────────────┘ │ ↓ │ │
|
|
75
|
+
│ project-review ─────┘ │
|
|
76
|
+
└──────────────────────────────┘
|
|
77
|
+
↓
|
|
78
|
+
/gsp:launch (optional)
|
|
62
79
|
```
|
|
63
80
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
**Creates:** `.design/BRIEF.md`
|
|
81
|
+
All artifacts live in `.design/` within your project directory.
|
|
67
82
|
|
|
68
83
|
---
|
|
69
84
|
|
|
70
|
-
###
|
|
85
|
+
### ◆ Diamond 1 — Branding
|
|
71
86
|
|
|
72
|
-
|
|
73
|
-
/gsp:project-research
|
|
74
|
-
```
|
|
87
|
+
Build your brand from research to design system. Each phase feeds the next.
|
|
75
88
|
|
|
76
|
-
|
|
89
|
+
> **Already have a brand?** Start with `/gsp:brand-audit` to assess what you have before evolving it.
|
|
77
90
|
|
|
78
|
-
|
|
91
|
+
#### 1. `/gsp:brand-research` — Market landscape
|
|
79
92
|
|
|
80
|
-
|
|
93
|
+
Research your audience, competitors, and market position. Understand the terrain before making decisions.
|
|
81
94
|
|
|
82
|
-
|
|
95
|
+
**Creates:** `.design/branding/{brand}/research/`
|
|
83
96
|
|
|
84
|
-
|
|
85
|
-
/gsp:brand
|
|
86
|
-
```
|
|
97
|
+
#### 2. `/gsp:brand-strategy` — Who you are
|
|
87
98
|
|
|
88
|
-
|
|
99
|
+
Define your archetype, positioning, and personality using the Kapferer Brand Identity Prism. The strategic foundation everything else builds on.
|
|
89
100
|
|
|
90
|
-
**Creates:** `.design/brand/
|
|
101
|
+
**Creates:** `.design/branding/{brand}/strategy/`
|
|
91
102
|
|
|
92
|
-
|
|
103
|
+
#### 3. `/gsp:brand-verbal` — How you sound
|
|
93
104
|
|
|
94
|
-
|
|
105
|
+
Craft your voice, tone spectrum, messaging framework, and naming conventions. Words that feel like you.
|
|
95
106
|
|
|
96
|
-
|
|
97
|
-
/gsp:system
|
|
98
|
-
```
|
|
107
|
+
**Creates:** `.design/branding/{brand}/verbal/`
|
|
99
108
|
|
|
100
|
-
|
|
109
|
+
#### 4. `/gsp:brand-identity` — How you look
|
|
101
110
|
|
|
102
|
-
|
|
111
|
+
Create your visual identity — logo directions, color palette, typography system, imagery style. Design decisions, not decoration.
|
|
103
112
|
|
|
104
|
-
|
|
113
|
+
**Creates:** `.design/branding/{brand}/identity/`
|
|
105
114
|
|
|
106
|
-
|
|
115
|
+
#### 5. `/gsp:brand-patterns` — Your design system
|
|
107
116
|
|
|
108
|
-
|
|
109
|
-
/gsp:project-design
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
Designs your screens and interaction flows following Apple HIG patterns. Layout, navigation, states, responsive behavior — all documented with enough detail to build from.
|
|
117
|
+
Translate your brand into tokens, components, and a living design system. Everything codified and ready to build with.
|
|
113
118
|
|
|
114
|
-
**Creates:** `.design/
|
|
119
|
+
**Creates:** `.design/branding/{brand}/system/`
|
|
115
120
|
|
|
116
121
|
---
|
|
117
122
|
|
|
118
|
-
###
|
|
123
|
+
### ◆ Diamond 2 — Project
|
|
119
124
|
|
|
120
|
-
|
|
121
|
-
/gsp:spec
|
|
122
|
-
```
|
|
125
|
+
Design and build a product using your brand. Critique loops catch issues before they ship.
|
|
123
126
|
|
|
124
|
-
|
|
127
|
+
#### 1. `/gsp:project-brief` — Scope what you're building
|
|
125
128
|
|
|
126
|
-
|
|
129
|
+
Define your project through guided Q&A — what it does, who it's for, what screens it needs. The brief that guides everything downstream.
|
|
127
130
|
|
|
128
|
-
|
|
131
|
+
**Creates:** `.design/projects/{project}/BRIEF.md`
|
|
129
132
|
|
|
130
|
-
|
|
133
|
+
#### 2. `/gsp:project-research` — Patterns and precedents
|
|
131
134
|
|
|
132
|
-
|
|
133
|
-
/gsp:project-review
|
|
134
|
-
```
|
|
135
|
+
Deep research into UX patterns, competitor approaches, and technical considerations for your specific project.
|
|
135
136
|
|
|
136
|
-
|
|
137
|
-
- **Design Critique** — Structured critique using Nielsen's 10 usability heuristics
|
|
138
|
-
- **Accessibility Audit** — WCAG 2.2 AA compliance check
|
|
137
|
+
**Creates:** `.design/projects/{project}/research/`
|
|
139
138
|
|
|
140
|
-
|
|
139
|
+
#### 3. `/gsp:project-design` — Screens and flows
|
|
141
140
|
|
|
142
|
-
|
|
141
|
+
Design your UI screens and interaction flows following Apple HIG patterns. Layout, navigation, states, responsive behavior — documented to build from.
|
|
143
142
|
|
|
144
|
-
|
|
143
|
+
**Creates:** `.design/projects/{project}/design/`
|
|
145
144
|
|
|
146
|
-
|
|
145
|
+
#### 4. `/gsp:project-critique` — Critique + accessibility
|
|
147
146
|
|
|
148
|
-
|
|
149
|
-
/gsp:project-build
|
|
150
|
-
```
|
|
147
|
+
Two parallel audits: structured design critique using Nielsen's 10 usability heuristics, and a WCAG 2.2 AA accessibility check. If issues surface, loop back and fix before building.
|
|
151
148
|
|
|
152
|
-
|
|
149
|
+
**Creates:** `.design/projects/{project}/critique/`
|
|
153
150
|
|
|
154
|
-
|
|
151
|
+
#### 5. `/gsp:project-build` — Designs to code
|
|
155
152
|
|
|
156
|
-
|
|
153
|
+
Translate reviewed designs into production-ready frontend code — written directly into your codebase. Components, styles, interactions built from your design system and tokens.
|
|
157
154
|
|
|
158
|
-
|
|
155
|
+
**Creates:** Components and styles in your codebase
|
|
159
156
|
|
|
160
|
-
|
|
161
|
-
/gsp:launch
|
|
162
|
-
```
|
|
157
|
+
#### 6. `/gsp:project-review` — QA against designs
|
|
163
158
|
|
|
164
|
-
|
|
159
|
+
Validate what was built against the original design intent. Catches drift between design decisions and implementation.
|
|
165
160
|
|
|
166
|
-
**Creates:** `.design/
|
|
161
|
+
**Creates:** `.design/projects/{project}/review/`
|
|
167
162
|
|
|
168
163
|
---
|
|
169
164
|
|
|
170
|
-
###
|
|
165
|
+
### Optional: `/gsp:launch`
|
|
171
166
|
|
|
172
|
-
|
|
173
|
-
/gsp:start → BRIEF.md
|
|
174
|
-
↓
|
|
175
|
-
/gsp:project-research → .design/research/TRENDS.md
|
|
176
|
-
↓
|
|
177
|
-
/gsp:brand → .design/brand/IDENTITY.md
|
|
178
|
-
↓
|
|
179
|
-
/gsp:system → .design/system/SYSTEM.md + tokens.json
|
|
180
|
-
↓
|
|
181
|
-
/gsp:project-design → .design/screens/SCREENS.md
|
|
182
|
-
↓
|
|
183
|
-
/gsp:spec → .design/specs/SPECS.md
|
|
184
|
-
↓
|
|
185
|
-
/gsp:project-review → .design/review/CRITIQUE.md + ACCESSIBILITY.md
|
|
186
|
-
↓ (loop back if issues found)
|
|
187
|
-
/gsp:project-build → .design/build/CODE.md + components/
|
|
188
|
-
↓
|
|
189
|
-
/gsp:launch → .design/launch/CAMPAIGN.md
|
|
190
|
-
```
|
|
167
|
+
Create marketing campaign assets — landing page copy, social media content, launch materials. Your product ships with a story, not just code.
|
|
191
168
|
|
|
192
|
-
|
|
169
|
+
**Creates:** `.design/projects/{project}/launch/`
|
|
193
170
|
|
|
194
171
|
---
|
|
195
172
|
|
|
196
173
|
## Commands
|
|
197
174
|
|
|
175
|
+
### Entry
|
|
176
|
+
|
|
198
177
|
| Command | What it does |
|
|
199
178
|
|---------|--------------|
|
|
200
|
-
| `/gsp:start` |
|
|
201
|
-
| `/gsp:project-research` | Analyze design trends for your industry |
|
|
202
|
-
| `/gsp:brand` | Create brand identity (strategy, logo, color, type) |
|
|
203
|
-
| `/gsp:system` | Build design system foundations + tokens |
|
|
204
|
-
| `/gsp:project-design` | Design UI/UX screens and flows |
|
|
205
|
-
| `/gsp:spec` | Generate implementation specifications |
|
|
206
|
-
| `/gsp:project-review` | Design critique + accessibility audit |
|
|
207
|
-
| `/gsp:project-build` | Translate designs to production code |
|
|
208
|
-
| `/gsp:launch` | Create marketing campaign assets |
|
|
179
|
+
| `/gsp:start` | Pick up where you left off — routes you forward |
|
|
209
180
|
| `/gsp:progress` | Check project status |
|
|
210
181
|
| `/gsp:help` | Show command reference |
|
|
211
182
|
|
|
183
|
+
### Branding
|
|
184
|
+
|
|
185
|
+
| Command | What it does |
|
|
186
|
+
|---------|--------------|
|
|
187
|
+
| `/gsp:brand-audit` | Audit an existing brand before evolving it |
|
|
188
|
+
| `/gsp:brand-research` | Research market, audience, competitors |
|
|
189
|
+
| `/gsp:brand-strategy` | Define archetype, positioning, personality |
|
|
190
|
+
| `/gsp:brand-verbal` | Craft voice, tone, messaging, naming |
|
|
191
|
+
| `/gsp:brand-identity` | Create visual identity — logo, color, type |
|
|
192
|
+
| `/gsp:brand-patterns` | Build design system — tokens, components |
|
|
193
|
+
|
|
194
|
+
### Project
|
|
195
|
+
|
|
196
|
+
| Command | What it does |
|
|
197
|
+
|---------|--------------|
|
|
198
|
+
| `/gsp:project-brief` | Scope through guided Q&A |
|
|
199
|
+
| `/gsp:project-research` | UX patterns, competitor analysis |
|
|
200
|
+
| `/gsp:project-design` | Design screens and interaction flows |
|
|
201
|
+
| `/gsp:project-critique` | Nielsen's heuristics + WCAG 2.2 AA audit |
|
|
202
|
+
| `/gsp:project-build` | Translate designs to production code |
|
|
203
|
+
| `/gsp:project-review` | QA validation against designs |
|
|
204
|
+
| `/gsp:launch` | Marketing campaign assets |
|
|
205
|
+
|
|
206
|
+
### Utility
|
|
207
|
+
|
|
208
|
+
| Command | What it does |
|
|
209
|
+
|---------|--------------|
|
|
210
|
+
| `/gsp:add-reference` | Add reference material to a project |
|
|
211
|
+
| `/gsp:doctor` | Check project health |
|
|
212
|
+
| `/gsp:update` | Update GSP to latest version |
|
|
213
|
+
| `/gsp:art` | Craft ASCII art interactively |
|
|
214
|
+
| `/gsp:pretty` | Surprise ASCII art in the terminal |
|
|
215
|
+
|
|
212
216
|
---
|
|
213
217
|
|
|
214
|
-
## Agents
|
|
218
|
+
## Agents
|
|
215
219
|
|
|
216
|
-
GSP ships with
|
|
220
|
+
GSP ships with 16 specialized agents, each modeled after a real design discipline:
|
|
217
221
|
|
|
218
222
|
| Agent | Role |
|
|
219
223
|
|-------|------|
|
|
220
|
-
| **
|
|
221
|
-
| **
|
|
222
|
-
| **Identity Designer** | Visual identity — logo
|
|
223
|
-
| **
|
|
224
|
-
| **UI/UX Designer** | App UI design following Apple HIG |
|
|
225
|
-
| **Campaign Director** | Marketing campaign asset libraries |
|
|
226
|
-
| **Project Scoper** | Implementation specifications for any UI target |
|
|
227
|
-
| **Design Critic** | Structured critiques using Nielsen's 10 heuristics |
|
|
228
|
-
| **Trend Researcher** | Industry trend analysis and competitive research |
|
|
229
|
-
| **Project Researcher** | Deep UX patterns, competitor analysis, technical research |
|
|
230
|
-
| **Design-to-Code Builder** | Design to production-ready frontend code |
|
|
231
|
-
| **Deliverable Reviewer** | Deliverable validation — token compliance, screen coverage |
|
|
224
|
+
| **Brand Strategist** | Brand strategy using Kapferer Prism, archetypes, positioning |
|
|
225
|
+
| **Verbal Strategist** | Voice, tone spectrum, messaging, naming conventions |
|
|
226
|
+
| **Identity Designer** | Visual identity — logo, color palettes, typography systems |
|
|
227
|
+
| **Design System Architect** | Complete design systems — tokens, components, foundations |
|
|
232
228
|
| **Brand Auditor** | Brand coherence assessment and evolution mapping |
|
|
233
|
-
| **
|
|
234
|
-
| **
|
|
229
|
+
| **Trend Researcher** | Market landscape, competitor analysis, emerging patterns |
|
|
230
|
+
| **Project Researcher** | Deep UX patterns, competitor UX, technical approaches |
|
|
231
|
+
| **Project Scoper** | Project scope through guided Q&A |
|
|
232
|
+
| **UI/UX Designer** | Screen design and interaction flows following Apple HIG |
|
|
233
|
+
| **Design Critic** | Structured critiques using Nielsen's 10 heuristics |
|
|
234
|
+
| **Accessibility Auditor** | WCAG 2.2 AA compliance auditing |
|
|
235
|
+
| **Design-to-Code Builder** | Designs to production-ready frontend code |
|
|
236
|
+
| **Deliverable Reviewer** | QA validation — implementation against design intent |
|
|
237
|
+
| **Campaign Director** | Marketing campaign asset libraries |
|
|
238
|
+
| **Codebase Scanner** | Tech stack detection and existing pattern inventory |
|
|
239
|
+
| **ASCII Artist** | Terminal ASCII art — context-aware art generation |
|
|
235
240
|
|
|
236
|
-
Each agent
|
|
241
|
+
Each agent carries deep reference material — Apple HIG patterns, Nielsen's heuristics, WCAG checklists, design token standards — baked into its prompts.
|
|
237
242
|
|
|
238
243
|
---
|
|
239
244
|
|
|
@@ -326,6 +331,6 @@ MIT License. See [LICENSE](LICENSE) for details.
|
|
|
326
331
|
|
|
327
332
|
<div align="center">
|
|
328
333
|
|
|
329
|
-
**
|
|
334
|
+
**Ship a brand, not just code.**
|
|
330
335
|
|
|
331
336
|
</div>
|
package/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.4.
|
|
1
|
+
0.4.3
|
package/package.json
CHANGED