Quickstart

Get from zero to a working PRD in under 5 minutes.

Prerequisites

• Node.js ≥ 18 (Node 22 LTS recommended)
• pnpm ≥ 10 — install pnpm

1. Install

pnpm add -g @n-dx/core

2. Initialize

Navigate to your project and run:

ndx init .

You'll be asked to choose an LLM provider (Claude or Codex). The init command sets up everything — analysis metadata, PRD storage, agent configuration, and assistant-specific artifacts:

• Claude: CLAUDE.md, .claude/skills/, .claude/settings.local.json, MCP server registration
• Codex: AGENTS.md, .agents/skills/, .codex/config.toml

By default both surfaces are provisioned. Use --claude-only or --codex-only to limit to one assistant.

Already initialized?

Running ndx init again is safe. It detects existing assistant surfaces and reuses them. If only one assistant's artifacts exist, re-init skips the other unless you explicitly request it.

3. Analyze your codebase

ndx analyze .

This scans your project: file inventory, import graph, architectural zones, React components. Results are written to .sourcevision/ and used by subsequent commands.

4. Generate a PRD

ndx plan --accept .

This runs the analysis and generates PRD proposals based on findings — anti-patterns, missing features, architectural gaps. The --accept flag adds them to your PRD automatically. Without it, you'll review proposals interactively.

5. Check progress

ndx status .

You'll see a tree of epics, features, and tasks with completion stats.

6. Execute a task

ndx work --auto .

The agent picks the highest-priority pending task, builds a brief with codebase context, runs an LLM tool-use loop to implement it, and records the results.

7. Start the dashboard

ndx start .

Opens a web dashboard at http://localhost:3117 with interactive views of your codebase analysis, PRD tree, and agent runs.

What's next?

• Open your assistant: claude or codex — your assistant reads its instruction file and discovers skills automatically
• Add your own ideas: ndx add "Add SSO support with Google" .
• Run multiple tasks: ndx work --auto --iterations=4 .
• Self-healing loop: ndx self-heal 3 . (analyze → recommend → work, repeated)
• Submit feedback: /ndx-feedback "description" — files a GitHub issue with context
• Assistant surfaces: Getting Started — Assistant Surfaces
• Full command reference: Commands
• Workflow guide: Workflow