NordVPN-Servers

License Code of Conduct GitHub release (semver) Commits since release Repo size

Test result Code coverage GitHub Pages

A cross-platform PowerShell module for interacting with the NordVPN API.

Project logo

Introduction

This module provides various functions for retrieving country, grouping, technology, and server information from the web API provided by NordVPN. Possible filter parameters are generated dynamically by retrieving lists of valid entries from the API. Lists of countries, groups, technologies, and servers are included as an offline fallback, and these can be updated. Sessional caching of country, group, and technology data is customisable.

Documentation

Please see the help index here.

You can also see the GitHub repository here.

Configuration

Information on configuring the module can be found here.

Testing

The module includes a complete testing suite using Pester. This may be found in the tests directory in the module root. A custom script permits in-place integration testing by protecting related files. Test result and code coverage reports are included, as is a script for regenerating test data. Also included for reference is the script used to generate result & coverage badges for GitHub.

Updatable Help

This module supports updatable help, currently in UI cultures en-GB and en-US. You can download these directly here.

License

This module and its associated assets are released under the MIT license.

Contributing

Suggestions and pull requests are welcomed, provided they are beneficial and well-documented. A full contributing guide can be found here.

Translations

If you’d like to translate the help documentation, please create a pull request. Approved translations will also be added to the PowerShell Gallery and Updatable Help. The module itself does not currently support custom languages.

Requirements

This module works in PowerShell Desktop 5.1 and later, and PowerShell Core 6.1 and later. For PSCore, Windows, Linux, and macOS are supported.

Code of Conduct

Please adhere to the code of conduct which is adapted from the contributor covenant 2.0. Remember, we are a community.

Changelog

The module changelog can be found here.