Quickstart

Install the CLI, create a demo stack, and reach the web app in a few commands.

Requirements

macOS with Docker Desktop, or Linux with Docker Engine and Docker Compose.
A model provider API key for the backend you choose during setup.
Network access to fetch the CLI package and container images.
A shell where the OpenNeko binary can be placed on PATH.

Demo install

The fastest first run is the public bootstrap installer followed by demo setup. Demo mode starts the core services and an AdventureWorks sample database so you can test customer-data queries without connecting production systems.

Demo setup

curl -fsSL https://openneko.app/install.sh | sh
mkdir -p ~/openneko && cd ~/openneko
openneko setup --mode demo

The setup wizard can run in the terminal or open a browser flow at http://localhost:3000. It collects the admin database password, GraphJin URL, agent backend, model provider key, and optional research provider settings.

First checks

Verify the stack

openneko status
openneko logs
open http://localhost:3000

The web app defaults to port 3000.
The metadata Postgres service defaults to host port 5432.
The metadata GraphJin service defaults to host port 8089.
The demo customer GraphJin service defaults to port 8080 when the demo overlay is active.