Documentation
Run OpenNeko with confidence.
Install it, connect business systems, put recurring AI work under policy, and keep the deployment recoverable.
$ curl -fsSL https://openneko.app/install.sh | sh
$ mkdir -p ~/openneko && cd ~/openneko
$ openneko setup --mode demoFind your path
What are you here to do?
01
Install and connect
Get started
QuickstartStart a local demo stack and open OpenNeko in a few commands.→Install and upgradeChoose a deployment mode, run setup, and keep the stack current.→Connect dataGive OpenNeko governed access to the data it needs without handing it unrestricted database credentials.→Solution packsInstall a prepared set of connections, rules, watchers, skills, and actions for a business system.→Magento setupInstall OpenNeko, connect your Magento store read-only, verify the pack, and add governed changes only when you are ready.→
02
Put AI to work
Use OpenNeko
Product tourUnderstand the small set of objects you will use to operate OpenNeko.→Ask and BriefingUse conversation for investigation and Briefing for the work that should come to you.→Workflows and watchersTurn repeated checks and operating routines into work that runs on schedule or when a condition appears.→Actions and approvalsControl how AI-proposed changes move from a thread into a business system.→Knowledge and learningTurn working knowledge into reviewed, reusable context without silently rewriting the shipped product.→SkillsGive the AI a reusable method, references, and tools for a defined job.→
03
Set the boundaries
Secure and govern
Rules and governanceTranslate business boundaries into permissions, action policy, review, and evidence.→SecurityUnderstand where AI code runs, how network access is limited, and where credentials stay.→Audit and evidenceReview decisions, actions, security events, and the limits of the evidence kept inside one deployment.→SSO and sign-inChoose how operators authenticate and keep identity control with the deployment owner.→
04
Add systems and tools
Extend
PluginsAdd connectors, actions, authentication, and channels through isolated, reviewable packages.→Connected accountsLet an operator use their own account in an external service without sharing one organization-wide token.→Records and internal appsCreate governed operational records and simple internal apps without adding another business system.→
05
Run it over time
Operate
CLI referenceUse the openneko command to set up, operate, recover, and extend a deployment.→Backup and restoreCreate verified backups, protect the recovery key, and understand the destructive restore path before an incident.→ContributingSet up a development stack, make a focused change, and submit it with the required checks.→Licensing and trademarksUnderstand the repository license, contributor terms, third-party notices, and use of the OpenNeko name.→
Source of truth