nyxCorenyxCore

Quick Start

UserDeveloper3 min read

Quick Start

Get nyxCore running locally in under 10 minutes.

Prerequisites

You need Node.js 18+, Docker, and npm. That's it.

node --version   # must be >= 18
docker --version

1. Clone and Install

git clone <repo-url>
cd nyxcore-systems
npm install

2. Configure Environment

cp .env.example .env

Open .env and fill in the required values:

Variable How to get it
DATABASE_URL Keep the default for local dev
REDIS_URL Keep the default for local dev
AUTH_SECRET Run openssl rand -base64 32
ENCRYPTION_KEY Run openssl rand -base64 32
AUTH_URL Keep http://localhost:3000

Everything else is optional — you can add LLM provider keys and GitHub tokens later through the dashboard.

3. Start the Database

npm run docker:up      # starts PostgreSQL 16 (pgvector) + Redis 7
npm run db:push        # applies the Prisma schema
npm run db:generate    # generates the Prisma client
npm run db:seed        # creates the default tenant and built-in personas

Then apply Row-Level Security policies:

psql $DATABASE_URL -f prisma/rls.sql

4. Start the Dev Server

npm run dev

Or use the all-in-one script:

./scripts/dev-start.sh

Open http://localhost:3000. You should see the nyxCore dashboard.

5. Add Your First LLM Key

Go to Admin > API Keys and add a provider key. nyxCore uses the BYOK (Bring Your Own Key) model — your keys stay encrypted in your database and are never stored in plaintext.

Supported providers: Anthropic, OpenAI, Google, Ollama (self-hosted), Kimi.

6. Run Your First Workflow

  1. In the dashboard, go to Workflows and create a new workflow.
  2. Add a single LLM step with the prompt: Analyze the following topic and give me three key insights: {{input}}
  3. Set the input to any topic.
  4. Run it.

You'll see the step stream its output in real time via SSE. When it completes, the step data is saved to the database.

What's Next

  • Create a Persona to give your workflow a specialized expert identity (Admin > Personas)
  • Link a GitHub repository to a project to unlock file tree, code analysis, and memory sync
  • Set up an Axiom knowledge base to give workflows access to your documentation
  • Explore the Discussions feature for multi-provider consensus on complex questions

Available Scripts Reference

Script Purpose
npm run dev Development server with hot reload
npm run build Production build
npm run test Run unit tests (Vitest)
npm run typecheck TypeScript type check
npm run lint ESLint
npm run db:studio Prisma Studio at localhost:5555
npm run docker:down Stop containers (data preserved)

Pre-Commit Check

Before committing changes:

npm run typecheck && npm run lint && npm run test
Next
Your First Workflow