OpenNekoSee a demo
DocumentationQuickstart
Docs/Get started

Quickstart

Start a local demo stack and open OpenNeko in a few commands.

Source of truth
README.mdINSTALL.md

Before you start

  • macOS with Docker Desktop, or Linux with Docker Engine and Docker Compose.
  • A model-provider API key. You choose the provider during setup.
  • Ports 3000 (web) and 18080 (loopback-only OpenShell gateway) available. Setup can persist different ports when needed.

Install the demo

Demo mode includes sample business data, so you can test the product before connecting a live system.

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

Follow the setup prompts, then open http://localhost:3000.

Check the stack

Status and logs
openneko status
openneko logs

Go next

Connect a data sourceGive OpenNeko read access to approved business data.Install a solution packStart with packaged workflows, rules, and actions for a business system.Set action policiesDecide what AI may do, what needs approval, and what remains human-only.