Neko

Installation

Neko is a command line tool. Installation is super quick and you can be up and running within seconds.

Please see the Neko CLI for full details on each command.


Step 1: Prerequisites

Neko is installed using the dotnet CLI, which is included with the .NET SDK.

Package Manager Supported Platforms
dotnet
Mac Win Linux

Step 2: Install

Once you have the .NET SDK installed, it takes just a few seconds to install Neko.

dotnet tool install neko --global
neko start

That's it! Your new Neko website should be up and running.


Other Options

Update

Update to the latest release of Neko using the following command.

dotnet tool update neko --global

Uninstall

Done with Neko? It's okay, we understand.

Uninstalling Neko is just as simple as installing.

dotnet tool uninstall neko --global

All Neko related files and folders within your project can be deleted, such as the neko.yml file and the generated .neko folder.


Version Specific

When managing project dependencies, it is sometimes necessary to install a specific version of a software package to ensure compatibility or access to certain features.

In the following sample, replace [version] with the actual version number.

dotnet tool install neko --global --version [version]

Supported Platforms

Neko supports Windows, macOS, and Linux.

macOS

OS Version Architectures
macOS 10.15+ x64, Arm64

Windows

OS Version Architectures
Windows 10 Client Version 1607+ x64, x86, Arm64
Windows 11 Version 22000+ x64, x86, Arm64
Windows Server 2012+ x64, x86
Windows Server Core 2012+ x64, x86
Nano Server Version 1809+ x64

Linux

OS Version Architectures
Alpine Linux 3.15+ x64, Arm64, Arm32
CentOS Linux 7 x64
CentOS Stream Linux 8 x64
Debian 10+ x64, Arm64, Arm32
Fedora 36+ x64
openSUSE 15+ x64
Oracle Linux 7+ x64
Red Hat Enterprise Linux 7+ x64, Arm64
SUSE Enterprise Linux (SLES) 12 SP2+ x64
Ubuntu 18.04+ x64, Arm64, Arm32

Referenced by