Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/docs/content/docs/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ All commands default to the current working directory. Pass an optional
- `about` — print a one-page tool overview.
- `web [dir]` — launch the inspector UI (see Inspector page).
- `mcp` — start the MCP server.
- `raycast [dir]` — start the API server for the Raycast extension.

## page:list

Expand Down
1 change: 1 addition & 0 deletions apps/docs/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ details in seconds.
<Card title="CLI commands" href="/docs/cli" />
<Card title="Inspector UI" href="/docs/inspector" />
<Card title="MCP integration" href="/docs/mcp" />
<Card title="Raycast Extension" href="/docs/raycast" />
</Cards>
2 changes: 1 addition & 1 deletion apps/docs/content/docs/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"title": "next-lens docs",
"pages": ["index", "quickstart", "cli", "inspector", "mcp"]
"pages": ["index", "quickstart", "cli", "inspector", "mcp", "raycast"]
}
52 changes: 52 additions & 0 deletions apps/docs/content/docs/raycast.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Raycast Extension
description: Browse and search routes directly from Raycast.
---

<div className="not-prose">
<img
alt="Raycast Extension"
src="/images/raycast.png"
className="rounded-lg"
/>
</div>

The [Raycast extension](https://www.raycast.com/1weiho/next-lens) lets
you search and browse your Next.js App Router routes directly from Raycast.

<a
title="Install next-lens Raycast Extension"
href="https://www.raycast.com/1weiho/next-lens"
>
<img
src="https://www.raycast.com/1weiho/next-lens/install_button@2x.png?v=1.1"
height="64"
alt="Install next-lens"
style={{ height: '64px' }}
/>
</a>

## Start the API server

The Raycast extension requires a local API server to fetch route data. Start it
with:

```npm
npx next-lens raycast [target-directory]
```

This launches a headless API server and automatically opens the Raycast
extension.

## Options

- `-p, --port <port>` — server port (default `9453`).

## How it works

1. Run `next-lens raycast` in your Next.js project.
2. The CLI starts an API server exposing route data.
3. Raycast extension connects to `http://localhost:9453/api`.
4. Search and browse routes directly from Raycast.

The server runs until you press `Ctrl+C`.
Binary file added apps/docs/public/images/raycast.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.