tidewave 0.5.5 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [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
+* Write logs and instrumentation to a file so it works across multiple runtimes
+
 ## [0.5.5] - 2025-11-25
 
 * Fix missing items element on `project_eval`

package/README.md

@@ -8,15 +8,14 @@ more information.
 This project supports:
 
 - Next.js 15/16
+- TanStack Start with React
+- Vite with React/Vue (which includes Astro, VitePress, etc)
 
-- React + Vite frontends, with either a backend as a service (such as Supabase)
-  or a third-party framework
+If you are using React/Vue with Django, FastAPI, Flask, Phoenix, or Rails,
+[follow the steps here instead](http://hexdocs.pm/tidewave/frontend.html).
 
-If you are using React with Django, FastAPI, Flask, Phoenix, or Rails,
-[follow the steps here instead](http://hexdocs.pm/tidewave/react.html).
-
-This project can also be used through the CLI or as a standalone Model Context
-Protocol (MCP) server for your editors.
+This project can also be used through the CLI or as
+[a standalone Model Context Protocol server](https://hexdocs.pm/tidewave/mcp.html).
 
 ## Installation
 
@@ -38,7 +37,7 @@ 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
+In case the command above do not work, you can toggle the manual installation
 instructions below
 
 <details>
@@ -168,11 +167,56 @@ export async function register() {
 
 </details>
 
-### React + Vite
+### TanStack Start
+
+If you are using TanStack Start with React, install Tidewave with:
+
+```sh
+$ npm install -D tidewave
+# or
+$ yarn add -D tidewave
+# or
+$ pnpm add --save-dev tidewave
+# or
+$ bun add --dev tidewave
+```
+
+Then configure your `vite.config.js` (also works for `.ts` and `.mjs`):
+
+```javascript
+import { defineConfig } from 'vite';
+import tidewave from 'tidewave/vite-plugin';
+
+export default defineConfig({
+  plugins: [tidewave()],
+});
+```
+
+And finally create or modify `src/start.ts` file to import Tidewave in
+development:
+
+```ts
+import { createStart } from '@tanstack/react-start';
+
+// Import Tidewave only in development.
+if (process.env.NODE_ENV === 'development' && typeof window === 'undefined') {
+  import('tidewave/tanstack');
+}
+
+export const startInstance = createStart(() => {
+  return {};
+});
+```
+
+Now make sure
+[Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you
+are ready to connect Tidewave to your app.
+
+### Vite
 
-If you are building a front-end application, using a backend as a service, such
-as Supabase, or a non-officially supported web framework, we recommend using our
-React + Vite integration.
+If you are building a frontend application with React or Vue, using a backend as
+a service, such as Supabase, or a non-officially supported web framework, we
+recommend using our Vite integration.
 
 Install it with:
 
@@ -201,23 +245,41 @@ Now make sure
 [Tidewave is installed](https://hexdocs.pm/tidewave/installation.html) and you
 are ready to connect Tidewave to your app.
 
-If you are using Supabase or similar, you can prompt Tidewave to use the
-`supabase` CLI so it has complete access to your database. For non-officially
-supported web frameworks, our React + Vite integration allows Tidewave Web to
-perform changes on the front-end, and the agent will be able to modify your
-backend code as usual, but some functionality (such as accessing logs, doing
-database calls, etc) won't be available.
+Our Vite integration for React and Vue allows Tidewave Web to perform changes on
+the front-end, and the agent will be able to modify your backend code as usual,
+but some functionality (such as accessing logs, doing database calls, etc) won't
+be available. You can also use our
+[Figma Dev Mode](https://hexdocs.pm/tidewave/figma.html) and
+[Supabase](https://hexdocs.pm/tidewave/supabase.html) integration for additional
+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
+- `allow_remote_access:` 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)
 - `team`: enable Tidewave Web for teams
 
+## 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
 
 Tidewave.js also comes with a CLI for developers who want to use it as a
@@ -257,6 +319,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
 
@@ -285,8 +348,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 both
+Next.js and Vite integrations as well as the CLI interface.
 
 ## License