Install and Upgrade

Choose an install method, run setup, manage ports, and replace the CLI safely.

Install methods

Use the bootstrap installer for the shortest supported path. Use Homebrew or release archives when you need package-manager control or checksum verification.

Install commands

# Bootstrap installer
curl -fsSL https://openneko.app/install.sh | sh

# macOS package
brew install open-neko/tap/openneko

Linux archive install

# Linux manual install
curl -LO https://github.com/open-neko/openneko/releases/latest/download/openneko_<version>_linux_<arch>.tar.gz
curl -LO https://github.com/open-neko/openneko/releases/latest/download/checksums.txt
sha256sum -c checksums.txt --ignore-missing
tar -xzf openneko_<version>_linux_<arch>.tar.gz
sudo install -m 0755 openneko /usr/local/bin/openneko

Setup modes

Setup creates local configuration, generates service secrets, writes compose overlays, and starts the selected stack. Use --skip-onboarding when you want to stay in the terminal flow, and --skip-plugins when plugin install should happen later.

Mode	Services	Best for
prod	Core services: metadata database, metadata GraphJin, web, and worker	Real deployments with your own data sources and policies
demo	Core services plus AdventureWorks database, seed job, and customer-data GraphJin	Evaluation, demos, and training
dev	Core services with development overlays	Contributing to OpenNeko itself

Setup options

openneko setup --mode prod --skip-plugins
openneko setup --mode demo --plugins @open-neko/plugin-slack,@open-neko/plugin-shopify

Ports and overrides

The CLI reads a user override file from ~/.config/openneko/compose.override.yml and applies it alongside the generated stack. For simple port changes, environment variables are enough.

Override host ports

OPENNEKO_PORT=3001 \
OPENNEKO_DB_PORT=55432 \
OPENNEKO_GRAPHJIN_PORT=8090 \
openneko start --mode demo --detach

Upgrade and reset

There is no separate openneko upgrade command. Replace the CLI with your package manager or a fresh release archive, then restart the stack. Existing metadata and volumes are kept unless you explicitly remove them.

Upgrade and reset

# macOS
brew update && brew upgrade openneko

# If you installed the older formula before the cask switch
brew uninstall --formula openneko
brew install --cask open-neko/tap/openneko

# Reset local runtime state
openneko stop --volumes
openneko reset --all