neoctl is a command-line tool designed to simplify the deployment and management of NetApp Neo instances. It handles configuration, prerequisites verification, and lifecycle management (configure, start, stop, delete) for Neo Core, Neo UI, and the associated database.
- Automated Setup: Generates
docker-composeconfigurations for Neo stack. - Instance Management: Create, start, stop, and manage multiple named instances.
- Bundle Management: Automatically fetches and manages software versions from container registries.
- Prerequisites Verification: Checks for supported container runtimes (Docker/Podman) and utilities (
cifs-utils). - Log Management: Easy access to instance logs with archiving support.
- Bulk Operations: Manage all instances simultaneously with
--all. - Podman Support: Secure privilege escalation handling for Podman runtime.
Download the latest release for your operating system from the Releases page.
- Download the archive for your architecture (e.g.,
neoctl-linux-amd64.tar.gzorneoctl-darwin-arm64.tar.gz). - Extract the binary:
tar -xzvf neoctl-*.tar.gz - Move the binary to a directory in your
PATH:sudo mv neoctl /usr/local/bin/
- Download the zip file (e.g.,
neoctl-windows-amd64.zip). - Extract the
neoctl.exebinary. - Add the directory containing
neoctl.exeto your systemPATHenvironment variable.
Requirements:
- Go 1.22+
- Make
git clone https://github.com/netapp/neoctl.git
cd neoctl
make buildThis produces the neoctl binary in the current directory.
./neoctl instance neotest configure
./neoctl instance neotest startThat's it!!!
Access the Neo Console at http://localhost:8080 or http://your_ip:8081.
For detailed command usage and configuration options, please refer to DOCS.md.
See CONTRIBUTING.md for build instructions and contribution guidelines.
Copyright 2026 NetApp, Inc. All Rights Reserved.