Skip to content

Quick Start ​

Get productive with Nexus in 5 minutes. This guide covers the essential workflows.

Prerequisites ​

Before starting, make sure you've completed the Installation guide:

  1. Get your API key via CLI login or dashboard
  2. Configure your AI client with your API key
Quick Setup
Run `npx @nexus/cli auth login` to authenticate, then `npx @nexus/cli init` to configure your AI client automatically.

1. Search Documentation ​

Ask your AI to search library documentation:

Chat with AI
You: Search the Next.js docs for how to use server actions→ Calling query-docs libraryId: nextjs query: "server actions usage"AI: Based on the Next.js documentation, here's how to use server actions:Server Actions are asynchronous functions executed on the server...

Finding Library IDs ​

If you're not sure of the library ID, use resolve-library:

Chat with AI
You: Find the library ID for Prisma documentation→ Calling resolve-library libraryName: prismaAI: Found: prismaDescription: Next-generation ORM for Node.js and TypeScriptSnippets: 1,234

2. Save Project Context ​

Store information about your project so the AI remembers it:

Chat with AI
You: Save this project context: This is a Next.js 14 app using Prisma for the database, Tailwind for styling, and tRPC for the API layer. We follow the App Router conventions.→ Calling save-memory title: "Project Tech Stack" type: project_context project: my-appAI: Saved memory: Project Tech Stack

Memory Types ​

TypeUse For
project_contextTech stack, architecture, conventions
session_summaryWhat was accomplished in a session
decisionArchitectural decisions with rationale
correctionLessons learned, things to avoid

3. Recall Context ​

In a new session, load your project context:

Chat with AI (New Session)
You: Load the context for my-app project→ Calling get-project-context project: my-appAI: Here's the context for my-app:Project Context:- Next.js 14 with App Router- Prisma ORM- Tailwind CSS- tRPC API layer

4. Find MCP Servers ​

Discover MCP servers for additional capabilities:

Chat with AI
You: Find MCP servers for working with PostgreSQL→ Calling discover-servers query: "postgresql database"AI: Found 3 MCP servers:1. postgres (Official) Query and manage PostgreSQL databases2. supabase Supabase database and auth integration

Get Installation Config ​

Chat with AI
You: Get the installation config for the postgres MCP server→ Calling get-server-config serverId: postgresAI: Here's the config for Claude Desktop:
json
{
  "mcpServers": {
    "postgres": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-postgres"],
      "env": {
        "POSTGRES_URL": "postgresql://user:pass@localhost:5432/db"
      }
    }
  }
}

Common Workflows ​

📖

Learning a New Library

Use query-docs to search official documentation without hallucinations.

🔄

Continuing Work

Use get-project-context to load all saved context at the start of each session.

📝

Recording Decisions

Use save-memory with type 'decision' to document architectural choices.

🔌

Adding Integrations

Use discover-servers to find MCP servers for databases, APIs, and tools.

Tips for Best Results ​

Be Specific
When searching documentation, be specific about what you're looking for. "React useEffect cleanup" works better than just "useEffect".
Use Project Names
Always include a project name when saving memories. This keeps memories organized and makes retrieval more accurate.
Save Often
Save important context, decisions, and learnings as you work. Your future self (and AI) will thank you.

Troubleshooting ​

Authentication Error?
If you see "API key required" or "Authentication required", make sure you've: 1. Run `npx @nexus/cli auth login` to get your API key 2. Added `NEXUS_API_KEY` to your client config (or used CLI login)

See the Authentication Guide for detailed setup instructions.

Next Steps ​

Released under the MIT License.