DocumentationCLI reference
Docs/Operate

CLI reference

Use the openneko command to set up, operate, recover, and extend a deployment.

Command groups

JobCommands
Get startedsetup, instances, init, doctor, version
Operate the stackstart, upgrade, stop, status, logs, migrate, seed, reset
Protect databackup, restore, storage
Manage plugins and skillsinstall, remove, list, marketplace, secrets
Manage packspack list/inspect/plan/install/status/manage/doctor/configure/upgrade/uninstall
Manage recordsrecords import, records drop
Developeval

Discover options

Use built-in help
openneko --help
openneko <command> --help
openneko <group> <command> --help

The installed CLI is the authority for flags supported by that release. Use the source-linked guides on this site for the operating context around those commands.

Target a named customer installation
openneko --instance <name> <command>

Safe operations

  • For an unnamed installation, run commands from its deployment directory.
  • For a named installation, pass --instance <name> to every customer-specific command.
  • Use status and doctor before changing a production stack.
  • Back up and verify before upgrades, migrations, resets, or destructive records work.
  • Read the generated plan before installing or upgrading a solution pack.