Skip to content

NetApp/neoctl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Release CodeQL Dependabot Updates Dependency Graph

NetApp Neo CLI (neoctl)

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.

Features

  • Automated Setup: Generates docker-compose configurations 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.

Installation

Download Binary

Download the latest release for your operating system from the Releases page.

Linux / macOS

  1. Download the archive for your architecture (e.g., neoctl-linux-amd64.tar.gz or neoctl-darwin-arm64.tar.gz).
  2. Extract the binary:
    tar -xzvf neoctl-*.tar.gz
  3. Move the binary to a directory in your PATH:
    sudo mv neoctl /usr/local/bin/

Windows

  1. Download the zip file (e.g., neoctl-windows-amd64.zip).
  2. Extract the neoctl.exe binary.
  3. Add the directory containing neoctl.exe to your system PATH environment variable.

Build from Source

Requirements:

  • Go 1.22+
  • Make
git clone https://github.com/netapp/neoctl.git
cd neoctl
make build

This produces the neoctl binary in the current directory.

The Fast track

./neoctl instance neotest configure
./neoctl instance neotest start

That's it!!!
Access the Neo Console at http://localhost:8080 or http://your_ip:8081.

Documentation

For detailed command usage and configuration options, please refer to DOCS.md.

Contributing

See CONTRIBUTING.md for build instructions and contribution guidelines.

License

Copyright 2026 NetApp, Inc. All Rights Reserved.

About

CLI tool to manage NetApp Neo instances

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors