Skip to main content

Install on Windows

Use PowerShell to download and extract the tarball, then add the folder to your PATH.

warning

Windows support is experimental. Use at your own risk.
We recommend using Windows Subsystem for Linux (WSL) for a more stable experience.

Manual install​

Get the CLI tarball​

You can grab the nanocl tarball directly from the GitHub releases page.
You can also use the following commands to download and extract the tarball:

$dst = "$env:USERPROFILE\nanocl"
New-Item -ItemType Directory -Force -Path $dst | Out-Null
Invoke-WebRequest -Uri "https://github.com/next-hat/nanocl/releases/download/nanocl-0.18.0/nanocl_0.18.0_windows_amd64.tar.gz" -OutFile "$dst\nanocl.tar.gz"

Extracted directory layout:

<extract-dir>
├─ bin\
│  └─ nanocl.exe (the nanocl binary)
└─ share\
   └─ man\
      └─ man1\   (multiple man pages for nanocl and its subcommands)
# Windows 10+ includes tar
& tar -xzf "$dst\nanocl.tar.gz" -C $dst
# The binary is under bin\nanocl.exe
$bin = Join-Path $dst 'bin'
# Add to PATH (current session):
$env:Path = "$env:Path;$bin"
# Or copy to a directory already in PATH (requires admin):
# Copy-Item (Join-Path $bin 'nanocl.exe') "$env:ProgramFiles\nanocl\nanocl.exe" -Force

Compile from source​

If you're on a different architecture or prefer building from source.

Prerequisites:

  • Install Rust toolchain: https://www.rust-lang.org/tools/install
  • Visual Studio Build Tools (C++ build tools) or a working MSVC toolchain
  • OpenSSL and libpq development libraries if not bundled; on Windows these are typically statically linked during build if available
cargo install nanocl