Skip to content

Commit 8852a7d

Browse files
committed
feat(cli) | initial docs
1 parent 9423896 commit 8852a7d

7 files changed

Lines changed: 148 additions & 0 deletions

File tree

src/App.tsx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ const App = () => (
5757
path="/sdk/:slug"
5858
element={<DynamicDocPage section="sdk" />}
5959
/>
60+
<Route
61+
path="/cli/:slug"
62+
element={<DynamicDocPage section="cli" />}
63+
/>
6064
<Route
6165
path="/webhooks/:slug"
6266
element={<DynamicDocPage section="webhooks" />}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Showpass CLI
2+
3+
Build and manage event websites that connect directly to your Showpass venue.
4+
5+
## Install
6+
7+
```bash
8+
curl -fsSL "https://www.showpass.com/install.sh" | bash
9+
```
10+
11+
## Quick Start
12+
13+
```bash
14+
showpass init my-event-site
15+
```
16+
17+
This launches an interactive wizard that:
18+
- Signs you in to your Showpass account
19+
- Connects to your venue
20+
- Generates a React + TypeScript site with Showpass SDK pre-configured
21+
- Installs dependencies and starts the dev server
22+
23+
Your site will be running at `http://localhost:8080`.
24+
25+
## Requirements
26+
27+
| | |
28+
|---|---|
29+
| **OS** | macOS, Linux |
30+
| **Account** | Showpass account with venue access |
31+
32+
## See Also
33+
34+
- [Commands Reference](/cli/02-commands/)
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Commands
2+
3+
## init
4+
5+
Create a new Showpass project. Opens an interactive wizard.
6+
7+
```bash
8+
showpass init my-event-site
9+
```
10+
11+
Without a name, one is generated for you:
12+
13+
```bash
14+
showpass init
15+
```
16+
17+
## dev
18+
19+
Start the local development server with hot reload.
20+
21+
```bash
22+
showpass dev
23+
```
24+
25+
Runs on `http://localhost:8080` by default.
26+
27+
## build
28+
29+
Create a production-optimized build.
30+
31+
```bash
32+
showpass build
33+
```
34+
35+
Output is written to `dist/`.
36+
37+
## whoami
38+
39+
Display current authentication status.
40+
41+
```bash
42+
showpass whoami
43+
```
44+
45+
## logout
46+
47+
Clear saved credentials and venue selection.
48+
49+
```bash
50+
showpass logout
51+
```
52+
53+
## help
54+
55+
Show available commands:
56+
57+
```bash
58+
showpass --help
59+
```
60+
61+
Get help for a specific command:
62+
63+
```bash
64+
showpass init --help
65+
```

src/docs-app/data/seoData.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,18 @@ export const seoDataMap: Record<string, SEOData> = {
6666
keywords: "cart listener, cart quantity, cart monitoring, dynamic cart, cart events"
6767
},
6868

69+
// CLI
70+
"/cli/01-overview": {
71+
title: "Showpass CLI - Command Line Tool for Event Websites",
72+
description: "Build and manage event websites with the Showpass CLI. Quick-start tool to generate React + TypeScript sites with Showpass SDK pre-configured.",
73+
keywords: "showpass cli, command line tool, event website builder, react cli, typescript cli, showpass sdk, event site generator"
74+
},
75+
"/cli/02-commands": {
76+
title: "CLI Commands Reference - Showpass Developer Documentation",
77+
description: "Complete reference for Showpass CLI commands. Learn about init, build, dev, deploy, and all available CLI options and flags.",
78+
keywords: "showpass cli commands, cli reference, command line reference, cli documentation, showpass commands, cli options"
79+
},
80+
6981
// WordPress Plugin
7082
"/wordpress/01-getting-started-install-and-configure": {
7183
title: "Showpass WordPress Plugin - Installation & Configuration",

src/docs-app/ui/components/DynamicDocPage.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ interface DynamicDocPageProps {
1313
section:
1414
| "api"
1515
| "sdk"
16+
| "cli"
1617
| "advanced"
1718
| "wordpress"
1819
| "webhooks"

src/docs-app/ui/components/navigation/Navigation.tsx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ const getOpenSections = (currentPath: string): string[] => {
2828
if (currentPath.startsWith("/sdk/") || currentPath.startsWith("/widgets")) {
2929
return ["sdk"];
3030
}
31+
if (currentPath.startsWith("/cli/")) {
32+
return ["cli"];
33+
}
3134
if (currentPath.startsWith("/wordpress/")) {
3235
return ["showpass-wordpress-plugin"];
3336
}
@@ -275,6 +278,34 @@ const Navigation = ({ currentPath, onNavigate }: NavigationProps) => {
275278
</AccordionContent>
276279
</AccordionItem>
277280

281+
<AccordionItem value="cli">
282+
<AccordionTrigger className="px-[0.4rem] py-3 text-sm font-medium text-muted-foreground hover:text-foreground border-b-0 hover:no-underline">
283+
CLI
284+
</AccordionTrigger>
285+
<AccordionContent className="pb-2">
286+
<ul className="px-4 space-y-1">
287+
<li>
288+
<NavLink
289+
to="/cli/01-overview"
290+
className={navLinkClass}
291+
onClick={handleLinkClick}
292+
>
293+
Overview
294+
</NavLink>
295+
</li>
296+
<li>
297+
<NavLink
298+
to="/cli/02-commands"
299+
className={navLinkClass}
300+
onClick={handleLinkClick}
301+
>
302+
Commands Reference
303+
</NavLink>
304+
</li>
305+
</ul>
306+
</AccordionContent>
307+
</AccordionItem>
308+
278309
<AccordionItem value="showpass-wordpress-plugin">
279310
<AccordionTrigger className="px-[0.4rem] py-3 text-sm font-medium text-muted-foreground hover:text-foreground border-b-0 hover:no-underline">
280311
Showpass Wordpress plugin

src/shared/components/BreadcrumbNavigation.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ interface BreadcrumbItem {
1818
const sectionLabels: Record<string, string> = {
1919
api: 'API Reference',
2020
sdk: 'JavaScript SDK',
21+
cli: 'CLI',
2122
wordpress: 'WordPress Plugin',
2223
webhooks: 'Webhooks',
2324
'google-tag-manager': 'Google Tag Manager',

0 commit comments

Comments
 (0)