Skip to content

Commit 25b20ca

Browse files
ryanbas21claude
andcommitted
docs: add root README with package overview and quick start
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent fcfb57f commit 25b20ca

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# WolfCola DevTools
2+
3+
**Captures, correlates, and diagnoses** OIDC/OAuth 2.0 authentication flows in real time — works standalone with any OIDC provider or as an enhanced companion to the Ping Identity SDK.
4+
5+
A Chrome DevTools panel that replaces the Network-panel-and-jwt.io workflow with a single view: OIDC-annotated network traffic, SDK-level event correlation, inline JWT decoding, and an automated diagnosis engine that tells you what went wrong and how to fix it.
6+
7+
![Flow view with diagnosis banner and node rail](packages/devtools-extension/screenshots/Flow-Screen.png)
8+
9+
---
10+
11+
## Packages
12+
13+
| Package | Description | npm |
14+
| --- | --- | --- |
15+
| [`@wolfcola/devtools-extension`](packages/devtools-extension) | Chrome extension — DevTools panel with Timeline, Flow, and Learn views | private |
16+
| [`@wolfcola/devtools-bridge`](packages/devtools-bridge) | Opt-in SDK adapter — emits `AuthEvent`s from DaVinci, Journey, and OIDC clients | [![npm](https://img.shields.io/npm/v/@wolfcola/devtools-bridge)](https://www.npmjs.com/package/@wolfcola/devtools-bridge) |
17+
| [`@wolfcola/devtools-types`](packages/devtools-types) | Shared `AuthEvent` Effect Schema definitions and TypeScript types | [![npm](https://img.shields.io/npm/v/@wolfcola/devtools-types)](https://www.npmjs.com/package/@wolfcola/devtools-types) |
18+
19+
---
20+
21+
## Quick start
22+
23+
```bash
24+
pnpm install
25+
pnpm build
26+
```
27+
28+
Load the extension as unpacked from `packages/devtools-extension/dist/` — see the [extension README](packages/devtools-extension) for full instructions.
29+
30+
To wire up SDK-level events in your app:
31+
32+
```bash
33+
pnpm add @wolfcola/devtools-bridge
34+
```
35+
36+
```ts
37+
import { davinci } from '@forgerock/davinci-client';
38+
import { attachDevToolsBridge } from '@wolfcola/devtools-bridge';
39+
40+
const client = await davinci({ config });
41+
attachDevToolsBridge(client, config);
42+
```
43+
44+
The bridge is a no-op when the extension is not installed.
45+
46+
---
47+
48+
## Development
49+
50+
```bash
51+
pnpm install
52+
pnpm build # build all packages
53+
pnpm lint # eslint
54+
pnpm test # vitest
55+
```
56+
57+
---
58+
59+
## License
60+
61+
MIT — see [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)