https://github.com/stagewise-io/stagewise
What if Cursor, Github Copilot and Windsurf could actually interact with your browser? π¬ Comment on any DOM element π§ We send the real context to Windsurf β‘ Save time manually selecting files Setup in 30 seconds, fully open-source, works first prompt. Supports every framework with first party support for React, Next.js, Vue and Nuxt.js
https://github.com/stagewise-io/stagewise
code-editor cursor cursor-ai ide vscode vscode-extension windsurf windsurf-extension
Last synced: 4 months ago
JSON representation
What if Cursor, Github Copilot and Windsurf could actually interact with your browser? π¬ Comment on any DOM element π§ We send the real context to Windsurf β‘ Save time manually selecting files Setup in 30 seconds, fully open-source, works first prompt. Supports every framework with first party support for React, Next.js, Vue and Nuxt.js
- Host: GitHub
- URL: https://github.com/stagewise-io/stagewise
- Owner: stagewise-io
- License: agpl-3.0
- Created: 2025-04-26T12:43:16.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-06-06T21:04:03.000Z (4 months ago)
- Last Synced: 2025-06-07T05:08:30.634Z (4 months ago)
- Topics: code-editor, cursor, cursor-ai, ide, vscode, vscode-extension, windsurf, windsurf-extension
- Language: TypeScript
- Homepage: https://stagewise.io
- Size: 10.8 MB
- Stars: 3,098
- Watchers: 14
- Forks: 147
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- StarryDivineSky - stagewise-io/stagewise
README
#
stagewise
# Eyesight for your AI-powered Code Editor.
[](https://marketplace.visualstudio.com/items?itemName=stagewise.stagewise-vscode-extension) [](https://github.com/stagewise-io/stagewise) [](https://discord.gg/gkdGsDYaKA)

## About the project
**stagewise is a browser toolbar that connects your frontend UI to your code ai agents in your code editor.**
* π§ Select any element(s) in your web app
* π¬ Leave a comment on it
* π‘ Let your AI-Agent do the magic> Perfect for devs tired of pasting folder paths into prompts. stagewise gives your AI real-time, browser-powered context.
## β¨ Features
The stagewise Toolbar makes it incredibly easy to edit your frontend code with AI agents:
* β‘ Works out of the box
* π οΈ Customise using your own configuration file
* π¦ Does not impact bundle size
* π§ Sends DOM elements, screenshots & metadata to your AI agent
* π Comment directly on live elements in the browser
* π§ͺ Comes with playgrounds for React, Vue, and Svelte (`./playgrounds`)## π Quickstart
### 1. π§© **Install the vs-code extension**
Install the extension here: https://marketplace.visualstudio.com/items?itemName=stagewise.stagewise-vscode-extension
### 2. π¨π½βπ» **Install and inject the toolbar**
> [!TIP]
> πͺ **Auto-Install the toolbar (AI-guided):**
> 1. In Cursor, Press `CMD + Shift + P`
> 2. Enter `setupToolbar`
> 3. Execute the command and the toolbar will init automatically π¦Or follow the manual way:
Install [@stagewise/toolbar](https://www.npmjs.com/package/@stagewise/toolbar):
```bash
pnpm i -D @stagewise/toolbar
```Inject the toolbar into your app dev-mode:
```ts
// 1. Import the toolbar
import { initToolbar } from '@stagewise/toolbar';// 2. Define your toolbar configuration
const stagewiseConfig = {
plugins: [],
};// 3. Initialize the toolbar when your app starts
// Framework-agnostic approach - call this when your app initializes
function setupStagewise() {
// Only initialize once and only in development mode
if (process.env.NODE_ENV === 'development') {
initToolbar(stagewiseConfig);
}
}// Call the setup function when appropriate for your framework
setupStagewise();
```
> β‘οΈ The toolbar will **automatically connect** to the extension!> [!IMPORTANT]
> π« **If nothing happens when a prompt is sent:**
>
> If you have multiple Cursor windows open, the toolbar may send prompts to the wrong window, making it appear as if "no prompt is being sent". To ensure reliable operation:
> - Keep only one Cursor window open when using stagewise
>
> A fix for this is on the way!### Framework-specific integration examples
For easier integration, we provide framework-specific NPM packages that come with dedicated toolbar components (e.g., ``). You can usually import these from `@stagewise/[framework-name]`.
React.js
We provide the `@stagewise/toolbar-react` package for React projects. Initialize the toolbar in your main entry file (e.g., `src/main.tsx`) by creating a separate React root for it. This ensures it doesn't interfere with your main application tree.
```tsx
// src/main.tsx
import { StrictMode } from 'react';
import { createRoot } from 'react-dom/client';
import App from './App.tsx';
import { StagewiseToolbar } from '@stagewise/toolbar-react';
import './index.css';// Render the main app
createRoot(document.getElementById('root')!).render(
,
);// Initialize toolbar separately
const toolbarConfig = {
plugins: [], // Add your custom plugins here
};document.addEventListener('DOMContentLoaded', () => {
const toolbarRoot = document.createElement('div');
toolbarRoot.id = 'stagewise-toolbar-root'; // Ensure a unique ID
document.body.appendChild(toolbarRoot);createRoot(toolbarRoot).render(
);
});
```Next.js
Use the `@stagewise/toolbar-next` package for Next.js applications. Include the `` component in your root layout file (`src/app/layout.tsx`).
```tsx
// src/app/layout.tsx
import { StagewiseToolbar } from '@stagewise/toolbar-next';export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode;
}>) {
return (
{children}
);
}
```Nuxt.js
For Nuxt.js projects, you can use the `@stagewise/toolbar-vue` package. Place the `` component in your `app.vue` or a relevant layout file.
```vue
// app.vueimport { StagewiseToolbar, type ToolbarConfig } from '@stagewise/toolbar-vue';
const config: ToolbarConfig = {
plugins: [], // Add your custom plugins here
};
```
Vue.js
Use the `@stagewise/toolbar-vue` package for Vue.js projects. Add the `` component to your main App component (e.g., `App.vue`).
```vue
// src/App.vueimport { StagewiseToolbar, type ToolbarConfig } from '@stagewise/toolbar-vue';
const config: ToolbarConfig = {
plugins: [], // Add your custom plugins here
};
```
SvelteKit
For SvelteKit, you can integrate the toolbar using `@stagewise/toolbar` and Svelte's lifecycle functions, or look for a dedicated `@stagewise/toolbar-svelte` package if available. Create a component that conditionally renders/initializes the toolbar on the client side (e.g., `src/lib/components/StagewiseToolbarLoader.svelte` or directly in `src/routes/+layout.svelte`).
**Using `onMount` in `+layout.svelte` (with `@stagewise/toolbar`):**
```svelteimport { onMount } from 'svelte';
import { browser } from '$app/environment';
import { initToolbar, type ToolbarConfig } from '@stagewise/toolbar'; // Adjust path if neededonMount(() => {
if (browser) {
const stagewiseConfig: ToolbarConfig = {
plugins: [
// Add your Svelte-specific plugins or configurations here
],
};
initToolbar(stagewiseConfig);
}
});```
**Using a loader component (example from repository):**
The example repository uses a `ToolbarLoader.svelte` which wraps `ToolbarWrapper.svelte`. `ToolbarWrapper.svelte` would then call `initToolbar` from `@stagewise/toolbar`.```svelte
import type { ToolbarConfig } from '@stagewise/toolbar';
// ToolbarWrapper.svelte is a custom component that would call initToolbar
import ToolbarWrapper from './ToolbarWrapper.svelte';
import { browser } from '$app/environment';const stagewiseConfig: ToolbarConfig = {
plugins: [
// ... your svelte plugin config
],
};{#if browser}
{/if}
```
You would then use `StagewiseToolbarLoader` in your `src/routes/+layout.svelte`.## π€ Agent support
| **Agent** | **Supported** |
| -------------- | -------------- |
| Cursor | β |
| Windsurf | β |
| GitHub Copilot | β |
| Cline | β |
| BLACKBOXAI | β |
| Console Ninja | β |
| Continue.dev | β |
| Claude Code | β |
| Amazon Q | β |
| Cody | β |
| Qodo | β |## π£οΈ Roadmap
Check out our [project roadmap](./.github/ROADMAP.md) for upcoming features, bug fixes, and progress.
## π License
stagewise is developed by tiq UG (haftungsbeschrΓ€nkt) and offerend under the AGPLv3 license.
For more information on the license model, visit the [FAQ about the GNU Licenses](https://www.gnu.org/licenses/gpl-faq.html).
For use cases that fall outside the scope permitted by the AGPLv3 license, feel free to [π¬ Contact Us](#contact-us-section).
## π€ Contributing
We're just getting started and love contributions! Check out our [CONTRIBUTING.md](https://github.com/stagewise-io/stagewise/blob/main/CONTRIBUTING.md) guide to get involved. For bugs and fresh ideas, please [Open an issue!](https://github.com/stagewise-io/stagewise/issues)
## π¬ Community & Support
* πΎ [Join our Discord](https://discord.gg/gkdGsDYaKA)
* π Open an [issue on GitHub](https://github.com/stagewise-io/stagewise/issues) for dev support.## π¬ Contact Us
Got questions or want to license stagewise for commercial or enterprise use?
π§ **[sales@stagewise.io](mailto:sales@stagewise.io)**