Installation

Netdocs ships as a single CLI executable named netdocs. Most users should download a prebuilt binary; building from source is only needed if you're contributing.

Requirements

A supported OS: Linux, macOS, or Windows.
No .NET runtime required for the prebuilt/self-contained binaries.
The .NET 11 SDK (preview, pinned via global.json) is only needed to build from source.

Download a release (recommended)

Grab the build for your platform from the releases page.

Debian / Ubuntu RHEL / Fedora Windows Linux (portable) Docker

curl -LO https://github.com/XtremeOwnage/Netdocs/releases/latest/download/netdocs_amd64.deb
sudo apt install ./netdocs_amd64.deb
netdocs --help

sudo yum install https://github.com/XtremeOwnage/Netdocs/releases/latest/download/netdocs_x86_64.rpm
netdocs --help

Install with the one-line PowerShell installer — it downloads the latest netdocs.exe to %LOCALAPPDATA%\Programs\Netdocs and adds it to your user PATH:

irm https://raw.githubusercontent.com/XtremeOwnage/Netdocs/main/install/install.ps1 | iex

Install a specific version, or a local build, by downloading the script and passing options:

# a pinned release
.\install.ps1 -Version 1.2.3

# a binary you built yourself
.\install.ps1 -FromFile .\artifacts\bin\Netdocs.Cli\release\netdocs.exe

Prefer to manage it manually? Download netdocs.exe from the releases page and run it directly:

.\netdocs.exe --help

To remove it later, run uninstall.ps1 (also on the releases page).

Download the self-contained netdocs binary, then:

chmod +x netdocs
./netdocs --help

docker run --rm -v "$PWD:/site" ghcr.io/xtremeownage/netdocs:latest build --config /site/appsettings.json

See Docker for details.

Note

Exact asset file names may vary between releases — check the releases page for the file that matches your platform and architecture. Packaging details live under Packaging.

From source (contributors)

If you're hacking on Netdocs itself:

git clone https://github.com/XtremeOwnage/Netdocs.git
cd Netdocs
dotnet build Netdocs.slnx -c Release

Run the CLI directly through dotnet run:

dotnet run --project src/Netdocs.Cli -- build --config path/to/appsettings.json

Or publish your own self-contained executable:

dotnet publish src/Netdocs.Cli -c Release -r linux-x64 --self-contained \
  -p:PublishSingleFile=true -o dist
./dist/netdocs --help

Replace linux-x64 with win-x64 or osx-arm64 as appropriate.

Verify the install

netdocs --help

You should see the usage summary. Continue to the Quick start.