@buoy-gg/core 5.0.0 → 6.0.1
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 +85 -28
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,43 +1,100 @@
|
|
|
1
|
-
# @buoy/core
|
|
1
|
+
# @buoy-gg/core
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@buoy-gg/core)
|
|
4
|
+
[](https://www.npmjs.com/package/@buoy-gg/core)
|
|
4
5
|
|
|
6
|
+
**Devtools that live in your app. And answer to your agent.**
|
|
5
7
|
|
|
6
|
-
|
|
8
|
+
Buoy is a floating dev menu that ships inside your React Native app. Every request, state change, render, and frame — live on the phone, on your desktop, and in Claude or Cursor. Drop in one component, install the tools you want, and they appear in the menu on their own.
|
|
9
|
+
|
|
10
|
+
|
|
7
11
|
|
|
8
12
|
## Install
|
|
13
|
+
|
|
9
14
|
```bash
|
|
10
|
-
|
|
15
|
+
npm install @buoy-gg/core
|
|
11
16
|
```
|
|
12
17
|
|
|
13
|
-
## Quick
|
|
18
|
+
## Quick start
|
|
19
|
+
|
|
14
20
|
```tsx
|
|
15
|
-
import {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
const APPS: InstalledApp[] = [
|
|
20
|
-
{
|
|
21
|
-
id: 'env',
|
|
22
|
-
name: 'Environment',
|
|
23
|
-
icon: '🛰️',
|
|
24
|
-
component: EnvVarsModal,
|
|
25
|
-
singleton: true,
|
|
26
|
-
},
|
|
27
|
-
];
|
|
28
|
-
|
|
29
|
-
export function DevToolsHost() {
|
|
21
|
+
import { FloatingDevTools } from "@buoy-gg/core";
|
|
22
|
+
|
|
23
|
+
export default function App() {
|
|
30
24
|
return (
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
25
|
+
<>
|
|
26
|
+
{/* Your app */}
|
|
27
|
+
<FloatingDevTools />
|
|
28
|
+
</>
|
|
34
29
|
);
|
|
35
30
|
}
|
|
36
31
|
```
|
|
37
32
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
33
|
+
That's the whole setup — a floating dev menu appears inside your app. Install any tool package and it auto-appears in the menu; most need zero config, a few take one line (like passing `zustandStores` or calling `watchAtoms()`). Add a `licenseKey` prop to unlock [Pro](https://buoy.gg/pricing): production builds, the MCP server, and unlimited capture.
|
|
34
|
+
|
|
35
|
+
## The 15 tools
|
|
36
|
+
|
|
37
|
+
| Tool | Package | What it does |
|
|
38
|
+
| --- | --- | --- |
|
|
39
|
+
| [Network](https://buoy.gg/buoy/latest/docs/tools/network) | `@buoy-gg/network` | Every request, response, timing & error — GraphQL operations extracted and named |
|
|
40
|
+
| [Storage](https://buoy.gg/buoy/latest/docs/tools/storage) | `@buoy-gg/storage` | Browse & edit AsyncStorage, MMKV & SecureStore with change history |
|
|
41
|
+
| [Env](https://buoy.gg/buoy/latest/docs/tools/env) | `@buoy-gg/env` | Auto-discovers `EXPO_PUBLIC_` vars, validates types, scores config health |
|
|
42
|
+
| [Query](https://buoy.gg/buoy/latest/docs/tools/react-query) | `@buoy-gg/react-query` | TanStack Query cache — refetch, invalidate, simulate loading & error states |
|
|
43
|
+
| [Routes](https://buoy.gg/buoy/latest/docs/tools/routes) | `@buoy-gg/route-events` | Navigation events, the live stack, and the full sitemap — jump to any screen |
|
|
44
|
+
| [Debug Borders](https://buoy.gg/buoy/latest/docs/tools/debug-borders) | `@buoy-gg/debug-borders` | Depth-colored layout borders — tap any label for testID, a11y props & styles |
|
|
45
|
+
| [Highlight Updates](https://buoy.gg/buoy/latest/docs/tools/highlight-updates) | `@buoy-gg/highlight-updates` | Every render, with the cause: mount, state, props, or parent |
|
|
46
|
+
| [Bench](https://buoy.gg/buoy/latest/docs/tools/perf-monitor) | `@buoy-gg/perf-monitor` | UI/JS FPS, CPU, memory & jank on a real device — batch benchmarks, ranked reports |
|
|
47
|
+
| [Events](https://buoy.gg/buoy/latest/docs/tools/events) | `@buoy-gg/events` | One timeline across every tool, with LLM-friendly export presets |
|
|
48
|
+
| [Console](https://buoy.gg/buoy/latest/docs/tools/console) | `@buoy-gg/console` | Chrome-DevTools console on device — read logs with no cable and no Metro |
|
|
49
|
+
| [Redux](https://buoy.gg/buoy/latest/docs/tools/redux) | `@buoy-gg/redux` | Inspect, dispatch & time travel — flags actions that blow the frame budget |
|
|
50
|
+
| [Zustand](https://buoy.gg/buoy/latest/docs/tools/zustand) | `@buoy-gg/zustand` | State, diffs, jump-to-state, one-tap reset — no middleware needed |
|
|
51
|
+
| [Jotai](https://buoy.gg/buoy/latest/docs/tools/jotai) | `@buoy-gg/jotai` | One `watchAtoms()` call — every event shows `prev → next` |
|
|
52
|
+
| [Impersonate](https://buoy.gg/buoy/latest/docs/tools/impersonate) | `@buoy-gg/impersonate` | Switch users, roles & flags without rebuilding |
|
|
53
|
+
| [Overlay](https://buoy.gg/buoy/latest/docs/tools/image-overlay) | `@buoy-gg/image-overlay` | Pin Figma mockups pixel-perfect over the app |
|
|
54
|
+
|
|
55
|
+
Grab everything in one line:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npm i @buoy-gg/{core,network,storage,env,react-query,route-events,debug-borders,highlight-updates,perf-monitor,events,console,redux,zustand,jotai,impersonate,image-overlay}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Three surfaces, one live session
|
|
62
|
+
|
|
63
|
+
Every tool runs inside your app's process. The phone, the desktop, and your agent all see the same session, live.
|
|
64
|
+
|
|
65
|
+
- **On the phone** — tap the floating menu. Works on any device, no cable, no desktop app, no Metro.
|
|
66
|
+
- **On your desktop** — [Buoy Desktop](https://github.com/Buoy-gg/Buoy-Desktop) (free) mirrors the tools to full-screen panels on macOS, Windows & Linux, with a live FPS / CPU / memory HUD and remote control of the device.
|
|
67
|
+
- **Through your agent** — the [Buoy MCP server](https://buoy.gg/buoy/latest/docs/mcp) gives Claude Code, Cursor, or any MCP editor structured tool calls into the running app: read live state, tap real buttons, run benchmarks on a physical device.
|
|
68
|
+
|
|
69
|
+
## Free vs Pro
|
|
70
|
+
|
|
71
|
+
Every tool is **free** — no key, no signup, no time limit.
|
|
72
|
+
|
|
73
|
+
**Pro** unlocks production builds, the MCP server, and unlimited capture. Activate with one prop:
|
|
74
|
+
|
|
75
|
+
```tsx
|
|
76
|
+
<FloatingDevTools licenseKey="YOUR_LICENSE_KEY" />
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
**Weekend Pass:** every Saturday and Sunday, every Pro feature unlocks free for everyone — built into the product, not a promo. Details at [buoy.gg/pricing](https://buoy.gg/pricing).
|
|
80
|
+
|
|
81
|
+
## Safe in production
|
|
82
|
+
|
|
83
|
+
Everything runs in your app's process. The broker that mirrors the session to desktop and MCP binds to localhost only — nothing ever leaves your machine. You decide who sees the tools:
|
|
84
|
+
|
|
85
|
+
```tsx
|
|
86
|
+
{isInternalUser && <FloatingDevTools />}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
That one line is the whole production story: internal builds and flagged users get the full toolkit; everyone else gets nothing.
|
|
90
|
+
|
|
91
|
+
## Links
|
|
92
|
+
|
|
93
|
+
- [Full documentation](https://buoy.gg/buoy/latest/docs/overview)
|
|
94
|
+
- [GitHub](https://github.com/Buoy-gg/buoy)
|
|
95
|
+
- [Buoy Desktop](https://github.com/Buoy-gg/Buoy-Desktop)
|
|
96
|
+
- [Pricing](https://buoy.gg/pricing)
|
|
97
|
+
|
|
98
|
+
## License
|
|
42
99
|
|
|
43
|
-
|
|
100
|
+
Proprietary software. © Buoy LLC. All rights reserved. See the [Terms of Service](https://buoy.gg/terms).
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@buoy-gg/core",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "6.0.1",
|
|
4
|
+
"description": "Buoy devtools for React Native — a floating in-app dev menu; every tool streams live to your phone, desktop, and AI agent.",
|
|
5
5
|
"main": "lib/commonjs/index.js",
|
|
6
6
|
"module": "lib/module/index.js",
|
|
7
7
|
"types": "lib/typescript/module/index.d.ts",
|
|
@@ -22,10 +22,10 @@
|
|
|
22
22
|
],
|
|
23
23
|
"sideEffects": false,
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@buoy-gg/
|
|
26
|
-
"@buoy-gg/floating-tools-core": "
|
|
27
|
-
"@buoy-gg/floating-tools-react": "
|
|
28
|
-
"@buoy-gg/
|
|
25
|
+
"@buoy-gg/license": "6.0.1",
|
|
26
|
+
"@buoy-gg/floating-tools-core": "6.0.1",
|
|
27
|
+
"@buoy-gg/floating-tools-react": "6.0.1",
|
|
28
|
+
"@buoy-gg/shared-ui": "6.0.1"
|
|
29
29
|
},
|
|
30
30
|
"peerDependencies": {
|
|
31
31
|
"react": "*",
|