Getting Started

Overview

Vale Server is a cross-platform (Windows and macOS) desktop application that helps enforce writing style guides. It's built on top of, and offers a high degree of compatibility with, the Vale command-line tool.

Docusaurus themed imageDocusaurus themed image

The application consists of two parts: a server (which manages Vale-related configuration details) and a client (which displays Vale's results).

The server is embedded in the application itself and runs locally—meaning that your content is never transmitted, stored, or otherwise inspected.

Clients are third-party applications that communicate with Vale Server through its API, allowing you to use your favorite tools with your server-managed configurations.

Client implementations are currently available for Visual Studio Code, Atom, Sublime Text, Google Docs, and Google Chrome.

Installation

Vale Server supports macOS 10.12+ and Windows 10.

Download ValeServer-1.x-windows.exe (where 1.x will be the latest version) and follow the on-screen instructions:

A screenshot of Vale Server's InstallBuilder installer.

After installation, Vale Server will automatically launch in the background (http://localhost:7777 by default) and you will see its icon in your taskbar:

A screenshot of Vale Server's context menu.

Right-clicking this icon will open a menu that allows you to configure the server.

Activation

Usage of Vale Server requires a license key, which you can get from the main website.

To activate Vale Server on Windows, navigate to the application's context menu from the taskbar and select Enter License...:

A screenshot of Vale Server's 'Enter License' option.

You'll then be prompted to enter the license key that you either received with your purchase receipt (paid) or via email (trial):

A screenshot of Vale Server's 'Enter License' dialog.

If your license is successfully validated, you'll see the following notice appear:

A screenshot of Vale Server's 'license approved' dialog.

Otherwise, you'll see a message dialog indicating what went wrong.