Skip to content

Commit 92ecd85

Browse files
waynesuttonwaynesutton
committed
docs: add codex-sync plugin to Docs page install sections and sidebar
1 parent a0db01c commit 92ecd85

5 files changed

Lines changed: 116 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ Cloud-synced dashboards that track session activity, tool usage, and token spend
66

77
[Website](https://www.opensync.dev/) | [Docs](https://www.opensync.dev/docs) | [Dashboard](https://www.opensync.dev/)
88

9-
## Ecosystem
9+
## Opensync Ecosystem
1010

1111
| Project | Description | Links |
1212
| -------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
1313
| OpenSync | Dashboards for AI coding sessions | [Website](https://www.opensync.dev/) / [GitHub](https://github.com/waynesutton/opensync) |
1414
| opencode-sync-plugin | Sync OpenCode sessions | [GitHub](https://github.com/waynesutton/opencode-sync-plugin) / [npm](https://www.npmjs.com/package/opencode-sync-plugin) |
1515
| claude-code-sync | Sync Claude Code sessions | [GitHub](https://github.com/waynesutton/claude-code-sync) / [npm](https://www.npmjs.com/package/claude-code-sync) |
1616
| droid-sync | Sync Factory Droid sessions (community) | [GitHub](https://github.com/yemyat/droid-sync-plugin) / [npm](https://www.npmjs.com/package/droid-sync) |
17-
| codex-sync | Sync Codex CLI sessions | [GitHub](https://github.com/waynesutton/codex-sync) / [npm](https://www.npmjs.com/package/codex-sync) |
17+
| codex-sync | Sync Codex CLI sessions | [GitHub](https://github.com/waynesutton/codex-sync-plugin) / [npm](https://www.npmjs.com/package/codex-sync) |
1818

1919
## Features
2020

‎changelog.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
1818
- Added Codex CLI Plugin documentation section with installation, configuration, and commands
1919
- Updated analytics provider inference to recognize Codex models
2020
- Created docs/ADD-NEW-PLUGIN-TEMPLATE.md: reusable prompt template for adding future plugins
21+
- Docs page updates for codex-sync plugin:
22+
- Added codex-sync npm link to sidebar
23+
- Added Codex CLI card to hosted version "Install Plugins" section
24+
- Added codex-sync login to "Login and Sync" section
25+
- Added Codex CLI card to Quick Start "Install a Plugin" section
26+
- Updated Sessions View description to include CX badge
27+
- Updated markdown export content with codex-sync commands
2128

2229
### Fixed
2330

‎files.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ React frontend application.
5959
| `Login.tsx` | Public homepage with WorkOS AuthKit integration. Shows "Go to Dashboard" button when logged in (no auto-redirect), "Sign in" when logged out. Includes privacy messaging, "Syncs with" section showing supported CLI tools (OpenCode, Claude Code, Droid, Codex CLI, Cursor with coming soon badge), getting started section with plugin links including codex-sync (mobile-visible), tan mode theme support with footer (theme switcher, Terms/Privacy links), footer icons (GitHub, Discord, Support, Discussions), updated mockup with view tabs and OC/CC source badges (desktop-only), feature list with Sync/Search/Private/Tag/Export/Delete keywords and eval datasets tagline, Watch the demo link, trust message with cloud/local deployment info, real-time Platform Stats leaderboard (Top Models, Top CLI) above Open Source footer link |
6060
| `Dashboard.tsx` | Main dashboard with custom themed source filter dropdown (filters by user's enabled agents from Settings, dark/tan mode support, click-outside close, escape key close), source badges (CC/OC/FD), eval toggle button, Context link with search icon, setup banner for new users with 3-column plugin cards (OpenCode, Claude Code, Factory Droid), mobile-optimized header/filters/session rows, URL param support for deep linking from Context search (?session=id), Cmd/Ctrl+K shortcut to open Context search, MessageBubble with content normalization helpers (getPartTextContent, getToolName) for multi-plugin format support, flash-free session transitions using lastValidSessionRef cache (shows cached content until new data loads, subtle corner spinner), and five views: Overview (responsive stat grids), Sessions (mobile-friendly list with stacked layout), Evals (eval-ready sessions with export modal), Analytics (responsive breakdowns with collapsible filters), Wrapped (Daily Sync Wrapped visualization) |
6161
| `Settings.tsx` | Tabbed settings: API Access (two-column layout with Plugin Setup and AI Coding Agents sections, keys, endpoints with plugin links including codex-sync), Profile (collapsible section for privacy, account info, Legal section with Terms/Privacy links, Danger Zone with delete data/account options). AI Coding Agents section lets users enable/disable CLI tools for the source filter dropdown (OpenCode, Claude Code, Factory Droid, Codex CLI with supported status, Cursor, Continue, Amp, Aider, Goose, Mentat, Cline, Kilo Code). Back link navigates to /dashboard |
62-
| `Docs.tsx` | Comprehensive documentation page with instant typeahead search (Cmd/Ctrl+K shortcut), left sidebar navigation (hidden scrollbar), right table of contents, anchor tags, copy/view as markdown buttons, mobile responsive, works with both dark/tan themes. Search indexes all sections with keywords for quick navigation to any topic via hash anchor. Covers use hosted version (with features, plugin install, login/sync), self-hosting requirements with cloud and 100% local deployment options, quick start, dashboard features, OpenCode plugin, Claude Code plugin, Codex CLI plugin, API reference, search types, authentication, hosting, fork guide, troubleshooting, and FAQ. Links to opencode.ai, claude.ai, and openai.com/codex in hero and plugin sections. |
62+
| `Docs.tsx` | Comprehensive documentation page with instant typeahead search (Cmd/Ctrl+K shortcut), left sidebar navigation (hidden scrollbar) with npm links (opencode-sync-plugin, claude-code-sync, codex-sync), right table of contents, anchor tags, copy/view as markdown buttons, mobile responsive, works with both dark/tan themes. Search indexes all sections with keywords for quick navigation to any topic via hash anchor. Covers use hosted version (with features, 3-plugin install cards with OC/CC/CX badges, login/sync for all three plugins), self-hosting requirements with cloud and 100% local deployment options, quick start (3-plugin cards), dashboard features, OpenCode plugin, Claude Code plugin, Codex CLI plugin with full documentation sections, API reference, search types, authentication, hosting, fork guide, troubleshooting, and FAQ. Links to opencode.ai, claude.ai, and openai.com/codex in hero and plugin sections. |
6363
| `PublicSession.tsx` | Public session viewer for shared sessions (/s/:slug) with dark/tan theme toggle, content normalization for multi-plugin support, textContent fallback for empty parts |
6464
| `Evals.tsx` | Evals page with eval-ready session list, stats (including Factory Droid count), export modal (DeepEval JSON, OpenAI JSONL, Filesystem formats), source filter respects user's enabled agents from Settings |
6565
| `Context.tsx` | Dedicated context search page (/context) with paginated full-text search for sessions and messages, slide-over panel for viewing session details without navigation, message highlighting for search results, source badges using centralized utilities, no OpenAI key required |

‎src/pages/Docs.tsx‎

Lines changed: 94 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1429,6 +1429,11 @@ For Claude Code:
14291429
npm install -g claude-code-sync
14301430
\`\`\`
14311431
1432+
For Codex CLI:
1433+
\`\`\`bash
1434+
npm install -g codex-sync
1435+
\`\`\`
1436+
14321437
### Login and Sync
14331438
14341439
1. Sign in at https://www.opensync.dev
@@ -1439,6 +1444,8 @@ npm install -g claude-code-sync
14391444
opencode-sync login
14401445
# or
14411446
claude-code-sync login
1447+
# or
1448+
codex-sync login
14421449
\`\`\`
14431450
14441451
4. Enter the Convex URL and API key when prompted
@@ -1538,13 +1545,19 @@ npm install -g claude-code-sync
15381545
claude-code-sync login
15391546
\`\`\`
15401547
1548+
For Codex CLI:
1549+
\`\`\`bash
1550+
npm install -g codex-sync
1551+
codex-sync login
1552+
\`\`\`
1553+
15411554
## Dashboard Features
15421555
15431556
### Overview
15441557
The Overview tab shows key metrics: total sessions, tokens, cost, duration, models, and projects. Charts display usage trends over 30 days.
15451558
15461559
### Sessions View
1547-
Browse all synced sessions with sorting, filtering, and source badges (OC for OpenCode, CC for Claude Code). Click a session to view full conversation history.
1560+
Browse all synced sessions with sorting, filtering, and source badges (OC for OpenCode, CC for Claude Code, CX for Codex CLI). Click a session to view full conversation history.
15481561
15491562
### Evals Export
15501563
Mark sessions as eval-ready for export. Supports DeepEval JSON, OpenAI JSONL, and Filesystem formats for training and evaluation.
@@ -1991,6 +2004,20 @@ npm install
19912004
<Package className="h-3.5 w-3.5" />
19922005
claude-code-sync
19932006
</a>
2007+
<a
2008+
href="https://www.npmjs.com/package/codex-sync"
2009+
target="_blank"
2010+
rel="noopener noreferrer"
2011+
className={cn(
2012+
"flex items-center gap-1.5 px-3 py-1.5 rounded-full text-xs border transition-colors",
2013+
t.border,
2014+
t.textSubtle,
2015+
t.bgHover,
2016+
)}
2017+
>
2018+
<Package className="h-3.5 w-3.5" />
2019+
codex-sync
2020+
</a>
19942021
<a
19952022
href="https://www.opensync.dev"
19962023
target="_blank"
@@ -2016,7 +2043,7 @@ npm install
20162043
onCopyMarkdown={() =>
20172044
copySectionMarkdown(
20182045
"hosted",
2019-
`## Use the Hosted Version\n\nStart syncing sessions in under 2 minutes with https://www.opensync.dev/\n\n### Install Plugins\n\`\`\`bash\nnpm install -g opencode-sync-plugin\nnpm install -g claude-code-sync\n\`\`\`\n\n### Login and Sync\n1. Sign in at opensync.dev\n2. Generate an API key in Settings\n3. Run \`opencode-sync login\` or \`claude-code-sync login\`\n4. Start coding, sessions sync automatically`,
2046+
`## Use the Hosted Version\n\nStart syncing sessions in under 2 minutes with https://www.opensync.dev/\n\n### Install Plugins\n\`\`\`bash\nnpm install -g opencode-sync-plugin\nnpm install -g claude-code-sync\nnpm install -g codex-sync\n\`\`\`\n\n### Login and Sync\n1. Sign in at opensync.dev\n2. Generate an API key in Settings\n3. Run \`opencode-sync login\` or \`claude-code-sync login\` or \`codex-sync login\`\n4. Start coding, sessions sync automatically`,
20202047
)
20212048
}
20222049
/>
@@ -2247,6 +2274,37 @@ npm install
22472274
</div>
22482275
<CodeBlock code="npm install -g claude-code-sync" />
22492276
</div>
2277+
2278+
{/* Codex CLI */}
2279+
<div
2280+
className={cn(
2281+
"p-4 rounded-lg border",
2282+
t.bgCard,
2283+
t.border,
2284+
)}
2285+
>
2286+
<div className="flex items-center gap-2 mb-3">
2287+
<div className="w-6 h-6 rounded bg-purple-500/15 flex items-center justify-center">
2288+
<span className="text-[10px] font-medium text-purple-400">
2289+
CX
2290+
</span>
2291+
</div>
2292+
<span
2293+
className={cn("text-sm font-medium", t.textSecondary)}
2294+
>
2295+
Codex CLI
2296+
</span>
2297+
<a
2298+
href="https://www.npmjs.com/package/codex-sync"
2299+
target="_blank"
2300+
rel="noopener noreferrer"
2301+
className={cn("ml-auto text-[10px]", t.textDim)}
2302+
>
2303+
npm
2304+
</a>
2305+
</div>
2306+
<CodeBlock code="npm install -g codex-sync" />
2307+
</div>
22502308
</div>
22512309
</div>
22522310

@@ -2293,6 +2351,10 @@ npm install
22932351
or
22942352
</p>
22952353
<CodeBlock code="claude-code-sync login" />
2354+
<p className={cn("text-xs text-center", t.textDim)}>
2355+
or
2356+
</p>
2357+
<CodeBlock code="codex-sync login" />
22962358
</div>
22972359
</li>
22982360
<li>
@@ -2773,6 +2835,35 @@ npx convex dev`}
27732835
</code>
27742836
</p>
27752837
</div>
2838+
2839+
{/* Codex CLI */}
2840+
<div
2841+
className={cn(
2842+
"p-4 rounded-lg border",
2843+
t.bgCard,
2844+
t.border,
2845+
)}
2846+
>
2847+
<div className="flex items-center gap-2 mb-3">
2848+
<div className="w-6 h-6 rounded bg-purple-500/15 flex items-center justify-center">
2849+
<span className="text-[10px] font-medium text-purple-400">
2850+
CX
2851+
</span>
2852+
</div>
2853+
<span
2854+
className={cn("text-sm font-medium", t.textSecondary)}
2855+
>
2856+
Codex CLI
2857+
</span>
2858+
</div>
2859+
<CodeBlock code="npm install -g codex-sync" />
2860+
<p className={cn("mt-2 text-xs", t.textDim)}>
2861+
Then run{" "}
2862+
<code className={cn("px-1 rounded", t.bgCode)}>
2863+
codex-sync login
2864+
</code>
2865+
</p>
2866+
</div>
27762867
</div>
27772868
</div>
27782869
</div>
@@ -2805,7 +2896,7 @@ npx convex dev`}
28052896
/>
28062897
<p className={cn("mt-2 text-sm", t.textMuted)}>
28072898
Browse all synced sessions with sorting and filtering.
2808-
Source badges show OC (OpenCode) or CC (Claude Code) origin.
2899+
Source badges show OC (OpenCode), CC (Claude Code), or CX (Codex CLI) origin.
28092900
List view shows token count, cost, and duration. Timeline
28102901
view displays sessions chronologically grouped by project.
28112902
</p>

‎task.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ OpenSync supports two AI coding tools: **OpenCode** and **Claude Code**.
88

99
- [ ] (add next task here)
1010

11+
## Recently Completed (Docs Page codex-sync Updates)
12+
13+
- [x] Updated Docs.tsx with codex-sync plugin documentation
14+
- Added codex-sync npm link to sidebar alongside opencode-sync-plugin and claude-code-sync
15+
- Added Codex CLI card (purple CX badge) to hosted version "Install Plugins" section
16+
- Added codex-sync login command to "Login and Sync" section
17+
- Added Codex CLI card to Quick Start "Install a Plugin" section
18+
- Updated Sessions View description to include CX (Codex CLI) badge
19+
- Updated markdown content with codex-sync install and login commands
20+
- Updated markdown export string to include codex-sync
21+
- Build passes netlify build check
22+
1123
## Recently Completed (Codex CLI Plugin Integration)
1224

1325
- [x] codex-sync plugin integration for syncing OpenAI Codex CLI sessions

0 commit comments

Comments
 (0)