Skip to content
NSchema

Installation

NSchema ships as a .NET global tool named nschema.

Prerequisites

Section titled “Prerequisites”
  • .NET SDK 10.0 or later. The tool targets net10.0. Check with dotnet --version; install from dotnet.microsoft.com if needed.
  • A PostgreSQL database to manage (for the commands that touch one). Planning can also run offline against a state store, with no database connection.

Install

Section titled “Install”
Terminal window
dotnet tool install --global nschema

This installs the nschema command onto your PATH. Verify it:

Terminal window
nschema --version

Update

Section titled “Update”
Terminal window
dotnet tool update --global nschema

Uninstall

Section titled “Uninstall”
Terminal window
dotnet tool uninstall --global nschema

Shell completion

Section titled “Shell completion”

NSchema can emit a completion script for your shell — see the completion command.

Next steps

Section titled “Next steps”

With the tool installed, head to the Quickstart to scaffold a project and apply your first schema.