tidewave 0.6.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [v0.8.0] - 2026-07-22
+
+* Add the Tidewave Toolbar
+* Align minor version across Tidewave packages
+* Drop Next.JS support
+
+## [0.7.0] - 2026-06-14
+
+* Support namespaces/files in `get_docs` tool and make it return a list of exports
+* Support re-exports in `get_docs` lookups
+* Improve out-of-the-box experience for remote access (which remains opt-in)
+
 ## [0.6.0] - 2025-12-31
 
 * Tanstack support

package/README.md

@@ -7,9 +7,8 @@ more information.
 
 This project supports:
 
-- Next.js 15/16
 - TanStack Start with React
-- Vite with React/Vue
+- Vite with React/Vue (which includes Astro, VitePress, etc)
 
 If you are using React/Vue with Django, FastAPI, Flask, Phoenix, or Rails,
 [follow the steps here instead](http://hexdocs.pm/tidewave/frontend.html).
@@ -19,154 +18,6 @@ This project can also be used through the CLI or as
 
 ## Installation
 
-### Next.js
-
-If you are using Next.js, install Tidewave with:
-
-```sh
-$ npx tidewave install
-# or
-$ yarn dlx tidewave install
-# or
-$ pnpm dlx tidewave install
-# or
-$ bunx tidewave install
-```
-
-And you are almost there! Now make sure
-[Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you
-are ready to connect Tidewave to your app.
-
-In case the command abovees do not work, you can toggle the manual installation
-instructions below
-
-<details>
-<summary>Show manual installation steps</summary><br />
-
-**1. Add Tidewave as a dependency**
-
-```sh
-$ npm install -D tidewave
-# or
-$ yarn add -D tidewave
-# or
-$ pnpm add --save-dev tidewave
-# or
-$ bun add --dev tidewave
-```
-
-**2. Create `pages/api/tidewave.ts`**
-
-Then create `pages/api/tidewave.ts` with:
-
-```typescript
-import type { NextApiRequest, NextApiResponse } from 'next';
-
-export default async function handler(
-  req: NextApiRequest,
-  res: NextApiResponse,
-) {
-  if (process.env.NODE_ENV === 'development') {
-    const { tidewaveHandler } = await import('tidewave/next-js/handler');
-    const handler = await tidewaveHandler();
-    return handler(req, res);
-  } else {
-    res.status(404).end();
-  }
-}
-
-export const config = {
-  runtime: 'nodejs',
-  api: {
-    bodyParser: false, // Tidewave already parses the body internally
-  },
-};
-```
-
-**3. Create the proxy.ts or middleware.ts**
-
-If you are using Next.js 16+, then create (or modify) `proxy.ts` with:
-
-```typescript
-import { NextRequest, NextResponse } from 'next/server';
-
-export function proxy(req: NextRequest): NextResponse {
-  if (req.nextUrl.pathname.startsWith('/tidewave')) {
-    return NextResponse.rewrite(new URL('/api/tidewave', req.url));
-  }
-
-  // Here you could add your own logic or different middlewares.
-  return NextResponse.next();
-}
-```
-
-For Next.js 15+ and earlier, create (or modify) `middleware.ts` with:
-
-```typescript
-import { NextRequest, NextResponse } from 'next/server';
-
-export function middleware(req: NextRequest): NextResponse {
-  if (req.nextUrl.pathname.startsWith('/tidewave')) {
-    return NextResponse.rewrite(new URL('/api/tidewave', req.url));
-  }
-
-  // Here you could add your own logic or different middlewares.
-  return NextResponse.next();
-}
-
-export const config = {
-  matcher: ['/tidewave/:path*'],
-};
-```
-
-**4. Create instrumentation.ts**
-
-Finally, we expose your application's spans, events, and logs to Tidewave MCP.
-First install the NodeSDK:
-
-```sh
-npm install @opentelemetry/sdk-node
-npm install -D @opentelemetry/sdk-trace-base @opentelemetry/sdk-logs
-```
-
-And then create (or modify) a custom `instrumentation.ts` file in the root
-directory of the project (or inside `src` folder if using one):
-
-```typescript
-// instrumentation.ts
-import type { SpanProcessor } from '@opentelemetry/sdk-trace-base';
-import type { LogRecordProcessor } from '@opentelemetry/sdk-logs';
-
-export async function register() {
-  if (process.env.NEXT_RUNTIME === 'nodejs') {
-    const { NodeSDK } = await import('@opentelemetry/sdk-node');
-
-    // Add your app own processes here existing configuration
-    const sdkConfig: {
-      spanProcessors: SpanProcessor[];
-      logRecordProcessors: LogRecordProcessor[];
-    } = {
-      spanProcessors: [],
-      logRecordProcessors: [],
-    };
-
-    // Conditionally add Tidewave processors in development
-    if (process.env.NODE_ENV === 'development') {
-      const { TidewaveSpanProcessor, TidewaveLogRecordProcessor } =
-        await import('tidewave/next-js/instrumentation');
-
-      sdkConfig.spanProcessors.push(new TidewaveSpanProcessor());
-      sdkConfig.logRecordProcessors.push(new TidewaveLogRecordProcessor());
-    }
-
-    const sdk = new NodeSDK(sdkConfig);
-    sdk.start();
-  }
-}
-```
-
-</details>
-
 ### TanStack Start
 
 If you are using TanStack Start with React, install Tidewave with:
@@ -255,13 +106,39 @@ features.
 
 ### Configuration
 
-Next.js' `tidewaveHandler` and Vite's `tidewave` accept the configuration
-options below:
-
-- `allow_remote_access:` allow remote connections when true (default false).
-  Enable this only if you trust your network and you want Tidewave MCP to be
-  accessed from another trusted machine
+Vite's `tidewave` accepts the configuration options below:
+
+- `allowRemoteAccess`: Tidewave only allows requests from localhost by default,
+  even if your server listens on other interfaces, for security purposes. Read
+  [our security guidelines for more information and when to allow remote access](https://hexdocs.pm/tidewave/security.html)
+  (if you know what you are doing)
+- `allowedOrigins`: a list of values matched against the `Origin` header to
+  prevent cross origin and DNS rebinding attacks. Each value must be a string of
+  shape `[scheme:]//host[:port]`, where both scheme and port are optional. The
+  host may also start with `*`. Example: `["//localhost:8000", "//*.test"]`. By
+  default, Tidewave allows Vite's configured server host and port, using
+  `localhost` when Vite uses its implicit host
+- `tmpDir`: temporary directory Tidewave uses for screenshots and recordings.
+  Defaults to `tmp`, storing files under `tmp/tidewave/screenshots` and
+  `tmp/tidewave/recordings`
 - `team`: enable Tidewave Web for teams
+- `toolbar`: controls whether the Tidewave toolbar is injected into your HTML
+  pages. Defaults to `true`
+
+## Available tools
+
+- `get_docs` - get the documentation for a given module/namespace or a
+  class/interface/enum/type in that namespace. It consults the exact versions
+  used by the project, ensuring you always get correct information
+
+- `get_source_location` - get the source location for a given module/namespace
+  or a class/interface/enum/type in that namespace, so an agent can directly
+  read the source skipping search
+
+- `get_logs` - reads console log written by the server
+
+- `project_eval` - evaluates code within the runtime itself, giving the agent
+  access to dependencies, server code, and all in-memory data
 
 ## CLI
 
@@ -302,6 +179,7 @@ Here are some examples:
 
 ```bash
 # Local TypeScript/JavaScript files
+npx tidewave docs ./src/utils
 npx tidewave docs ./src/utils:formatDate
 npx tidewave docs ./components:Button#onClick
 
@@ -330,8 +208,8 @@ bun run clean            # Clean dist directory
 
 ## Acknowledgements
 
-A thank you to [Zoey](https://github.com/zoedsoupe/) for implementing both
-Next.js and Vite integrations as well as the CLI interface.
+A thank you to [Zoey](https://github.com/zoedsoupe/) for implementing the Vite
+integration as well as the CLI interface.
 
 ## License