Skip to main content
The WestyxNexus package is hosted on the GitLab Package Registry. It is public - no token is required to install.

1. Add the NuGet source

Choose one of the two options below. Both achieve the same end result.

Option A - CLI (one-time, machine-wide)

This appends the source to the user-level NuGet.Config. After this the source is available in every project on the machine.

Option B - nuget.config in your repo root

Commit this file to source control alongside your .csproj. The source is then scoped to the project - no machine-wide setup needed.

2. Install the packages you need

The SDK ships as six packages. The core is always required; add only the integrations you use.
A typical ASP.NET Core application needs two, each of which brings in the core package - Getting started wires them:
All six release together and always share a version number. This adds a <PackageReference> to your .csproj pulling the latest version from the GitLab feed. To pin to a specific version:

Requirements

  • .NET 10.0 or later. All six packages target net10.0 (LTS, supported to 2028-11-14). net8.0 reached end of support on 2026-11-10 and was dropped in v0.21.0. CI runs the suite on .NET 10 and forward-tests the net10.0 build on .NET 11.
  • Network access to gitlab.com for installation, and to <your-slug>.westyx.dev at runtime

Verifying connectivity

Before writing any code, confirm your endpoint and API key work with a plain curl:
A valid response returns a JSON snapshot with your configs, secrets, and flags. An HTTP 401 means the key is wrong; HTTP 404 means the slug is wrong. To watch the live SSE stream:
You should see event:resync arrive within a second. Press Ctrl+C to stop.

Troubleshooting

  • Unable to load the service index for source ... - usually a corporate proxy or firewall blocking GitLab. Confirm curl https://gitlab.com/api/v4/projects/81978985/packages/nuget/index.json returns JSON.
  • The package version 'X' could not be found - version not yet published, or the GitLab feed is being rebuilt. Check the Packages page for the available versions.
  • Multiple feeds returning the same package - NuGet uses the first feed where the package is found. Order matters in nuget.config. Put westyx-nexus above any catch-all feed.