@navieo/cli

CLI tool for Navieo — scan your codebase, generate sitemaps, and sync with the Navieo backend.

Installation

npm install -g @navieo/cli

Or run directly with npx:

npx @navieo/cli <command>

Commands

navieo init

Scan your codebase and generate an initial sitemap with a docs folder.

navieo init [--dir <path>]

• Detects your framework (Next.js App Router, Pages Router, Vite)
• Scans routes and extracts interactive elements
• Creates navieo/sitemap.navieo.json and navieo/docs/

navieo generate

Re-scan the codebase and update the existing sitemap, merging new routes with existing data.

navieo generate [--dir <path>]

navieo sync

Upload your sitemap and documentation to the Navieo backend.

navieo sync [--dir <path>] [--key <apiKey>] [--endpoint <url>]

Configuration

Create a .navieorc file in your project root:

{
  "apiKey": "your-api-key",
  "endpoint": "https://api.navieo.io"
}

Or set the NAVIEO_API_KEY environment variable.

Requirements

• Node.js >= 18

License

MIT