open-index/open-npm huggingface dataset:
npm package: @navieo/cli
Description: CLI tool for Navieo — scan, generate, and sync sitemaps
Latest version: 1.4.0

# @navieo/cli

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

## Installation

```bash
npm install -g @navieo/cli
```

Or run directly with npx:

```bash
npx @navieo/cli <command>
```

## Commands

### `navieo init`

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

```bash
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.

```bash
navieo generate [--dir <path>]
```

### `navieo push`

Pull the latest cloud state and upload your sitemap and documentation to the Navieo backend.

```bash
navieo push [--dir <path>] [--key <secretKey>] [--endpoint <url>] [--dry-run] [--no-pull]
```

### `navieo pull`

Download dashboard docs from the cloud to local files, detecting conflicts with local changes.

```bash
navieo pull [--dir <path>] [--key <secretKey>] [--endpoint <url>] [--dry-run]
```

## Configuration

Create a `.navieorc` file in your project root:

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

Or set the `NAVIEO_SECRET_KEY` environment variable.

## Requirements

- Node.js >= 18

## License

MIT
npm package: @navieo/react
Description: AI-powered contextual site guide SDK for React
Latest version: 1.5.0

# @navieo/react

AI-powered contextual site guide SDK for React and Next.js.

## Installation

```bash
npm install @navieo/react
```

## Quick Start

### React

```tsx
import { NavieoProvider, ChatWidget } from "@navieo/react";

function App() {
  return (
    <NavieoProvider currentRoute={window.location.pathname}>
      <ChatWidget />
      {/* your app */}
    </NavieoProvider>
  );
}
```

### Next.js

```tsx
import { NavieoNextProvider } from "@navieo/react/next";

export default function Layout({ children }) {
  return (
    <NavieoNextProvider>
      {children}
    </NavieoNextProvider>
  );
}
```

The Next.js provider automatically handles route detection and navigation.

## Exports

| Export | Description |
|--------|-------------|
| `NavieoProvider` | Context provider with tour and chat state management |
| `ChatWidget` | Built-in floating chat widget |
| `useNavieo` | Hook to access tour/chat state and actions |
| `useTourRenderer` | Hook for custom tour rendering with driver.js |
| `NavieoNextProvider` | Next.js wrapper (from `@navieo/react/next`) |

## Requirements

- React 18+ or 19+
- Next.js 14+ (optional, for `@navieo/react/next`)
- Node.js >= 18

## License

MIT
npm package: @navieo/types
Description: Shared TypeScript interfaces for Navieo
Latest version: 1.4.0

# @navieo/types

Shared TypeScript interfaces for Navieo.

## Installation

```bash
npm install @navieo/types
```

## Usage

```typescript
import type { SitemapData, GuideRequest, GuideResponse } from "@navieo/types";
```

## Exported Types

| Interface | Description |
|-----------|-------------|
| `ElementSelector` | CSS selector, aria label, text, or test ID for targeting UI elements |
| `SitemapElement` | An interactive element on a page (button, link, input, etc.) |
| `SitemapRoute` | A route/page with its path, title, description, and elements |
| `SitemapFlow` | A multi-step user flow across routes |
| `SitemapDoc` | A documentation page with sections |
| `SitemapData` | The complete sitemap containing routes, flows, and docs |
| `TourStep` | A single step in a guided tour |
| `GuideRequest` | Request payload for generating a guide |
| `GuideResponse` | Response containing tour steps and an answer |
| `SyncRequest` | Payload for syncing sitemap + docs to the backend |
| `DocFile` | A documentation file with path and content |

## License

MIT