Generate navigation routes

from their app’s codebase than hand-write each one in Navigation routes. The chatropic-guide-with-nav-route-generator skill scans your product’s routing layer and emits a ready-to-import route registry plus help-center markdown. It is a single Python 3 script with no dependencies, so it runs in Claude Code, Codex, Cursor, or a plain terminal, the only difference is how each tool triggers it.

The generated navigation-routes.json matches the route fields used in Navigation routes (label, path, description, keywords), so you can upload it directly in Navigation or POST each entry to the nav-routes API.

What it produces

Every run writes four files into the --out folder:

File	Contents
`navigation-routes.json`	Machine-readable routes, seed your nav/deeplink registry
`navigation-routes.md`	Human-readable table: breadcrumb, path, deep link, source
`how-to-guides.md`	How-to sections distilled from your `.md`/`.mdx` docs
`index.md`	Help-center landing page linking the above

Only user-facing pages are included. API endpoints, auth flows (login, logout, signup, oauth, sso, password reset, …), and webhooks are dropped automatically, they are not destinations a support agent would deep-link a customer to.

Prerequisites

python3 --version   # 3.9 or newer, no pip installs, no virtualenv

Install & run

Claude Code

Skills are auto-discovered from a skills/ folder.

# Personal (all projects)
cp -R chatropic-guide-with-nav-route-generator ~/.claude/skills/

# Or project-scoped (checked into the repo)
cp -R chatropic-guide-with-nav-route-generator .claude/skills/

Then invoke it in a session:

/chatropic-guide-with-nav-route-generator

…or just ask (“generate the Chatropic navigation routes from this repo”). Claude runs the script and writes a chatropic-help-guides/ folder in the working directory.

Codex (OpenAI Codex CLI)

Codex has no skills folder, make the script available and point the agent at it in AGENTS.md:

## Navigation-route generator
To regenerate the navigation route registry, run:
`python3 tools/chatropic-help-guide/generate_help_guides.py --source . --out ./chatropic-help-guides --product "Chatropic"`

Then ask Codex to “regenerate the navigation routes”, or run the command yourself (Terminal).

Cursor

Add a rule at .cursor/rules/nav-route-generator.mdc so the agent knows the command:

---
description: Generate the Chatropic navigation route registry
---
When asked to refresh navigation routes, run:
python3 tools/chatropic-help-guide/generate_help_guides.py --source . --out ./chatropic-help-guides --product "Chatropic"
Then let the user review the generated markdown, do not run any smoke test.

Prompt Cursor’s agent, or run it in Cursor’s integrated terminal (Terminal).

Terminal

The universal path, no agent involved.

python3 path/to/chatropic-guide-with-nav-route-generator/generate_help_guides.py \
  --source ./your-app \
  --out ./chatropic-help-guides \
  --base-url https://app.example.com \
  --product "Chatropic"

Flag	Purpose	Default
`--source`	codebase (routes + guides) or docs dir (guides only)	required
`--out`	output folder; relative paths land in the current directory	`chatropic-help-guides`
`--base-url`	base URL used to build deep links	(none)
`--product`	display name in generated headings	`Product`

Exit codes: 0 ok · 2 nothing found · 1 bad args.

Import the routes

After reviewing navigation-routes.json, register routes in the dashboard:

Open Navigation.
Drag and drop navigation-routes.json or click to browse.
Confirm imported routes in the sidebar list, edit or delete any that need adjustment.

For bulk automation or CI, use the Customer Support API instead, see Navigation routes, Configure routes (API). Add a description and keywords to each entry so the agent can match them with vector similarity.

Navigation routes

Configure and test routes the agent deep-links to.

Embed navigation

Host-side postMessage integration for clicks.

Quick Start

Integration

Navigation Routes

Reference

Generate navigation routes

What it produces

Prerequisites

Install & run

Claude Code

Codex (OpenAI Codex CLI)

Cursor

Terminal

Import the routes

Navigation routes

Embed navigation

​What it produces

​Prerequisites

​Install & run

​Claude Code

​Codex (OpenAI Codex CLI)

​Cursor

​Terminal

​Import the routes

Navigation routes

Embed navigation

What it produces

Prerequisites

Install & run

Claude Code

Codex (OpenAI Codex CLI)

Cursor

Terminal

Import the routes