Window Installation Instructions
Thank you for downloading the CSpell Java. This package includes one compressed file -- cSpell2018.tgz.
Download the cSpell2018.tgz file from
CSpell web site.
We recommend to use Firefox or Chrome for downloading cSpell2018.tgz (MS-IE changes the extension from tgz to gz and could cause issues when uncompressing it)
Uncompress and unarchive this file into the location where
you intend to have it installed.
On a windows platform, pkzip and winzip may be used to uncompress and unarchive this file. Winzip looks into the file to check if there is tar file within it, and it asks if it should create a temporary file with the tar file in it. The proper response is to allow this to happen. Once the temporary file has been created, winzip reads it and displays the archive as it would any other zip'ed file. Unzip the resulting contents to the location you want to install to. Make sure that you preserve the directory structures when unarchiving.
Once the files are in place, change directories to the top level. This should be cSpell2018. On a windows platform, this will involve opening up a DOS Command Prompt window (Start -> run -> cmd), and changing directories to where you have put these files. We will henceforth refer to this top level directory as the ${CSPELL_DIR} directory.
From the ${CSPELL_DIR}, invoke the appropriate installation command (do NOT double click on the installation script).
| Platforms | Installation Scripts |
| Windows | ./install_win.bat |
The scripts shown above will first install a copy of the JRE to ensure a compatible version of JRE for running the CSpell. On a PC/Windows platform, you may choose not to install JRE if your existing JRE is 1.8+. Then, the script proceeds to alter the configuration file settings to set the install location. If you install CSpell on a PC/Windows platform, choose NOT to restart your computer after JRE is installed. You may restart your computer after finishing CSpell installation. Please notes that only 64-bit JRE is supported.
The script will create a shell file in the ${CSPELL_DIR} bin directory for CSpell, with the proper environment set up. Also, it creates CSpell configuration file under ${CSPELL_DIR}/data/config/cSpell.properties.
Once done, the script will attempt to verify that the installation was successful.
If the installation was successful, there will be a congratulation message that finishes off this process. The installation process should take less than 1 minute.
If the installation is not successful, there will be a message indicating so. Please refer to the ${CSPELL_DIR}/logs directory for a complete transcript of the process. It is likely that there were error messages indicating the source of the failure.
After a successful installation
The CSpell are now ready to be used. The CSpell program can be found in the ${CSPELL_DIR}/bin directory.
On the Windows platform, the batch file is:
CSpell may be used from any location on the machine. If you put the ${CSPELL_DIR}/bin path in your ${PATH} environment variable they do not have to be referenced with the whole path.
> CSpell -p - Please input a term (type "Ctl-d" to quit) > He was dianosed early on set deminita 3year ago. He was diagnosed early onset dementia 3 year ago.
Other Platform - Manual Installation
The installation script does not provide options to install the CSpell on platform other than Linux and Windows. Users may follow instructions on manual installation instructions to install CSpell on different platforms. The manual installation page shows details of how the installation script configures and installs CSpell. Users may skip this section if they use installation script to install CSpell.
Altering your environment to use the CSpell, once they have been installed
You may invoke CSpell from a command line. CSpell is found in the ${CSPELL_DIR}/bin directory. You can add this ${CSPELL_DIR}/bin path to your ${PATH} environment variable. This would enable you to find and run these tools from any location.
On the Windows platform, this would be done by appending this path to the PATH variable from the "control panel\System\Advanced\Environment variable\Edit" menus.