Setup

It only takes a few minutes to install the SiteServer command line tool and get ready.

1. Download the SiteServer CLI

Go to the SiteServer CMS product download page, find the SiteServer CLI, and click the Download button.

The downloaded file is an executable file(siteserver.exe).

2. Run the SiteServer CLI

siteserver.exe needs to be executed from the command line. You can use command line tools such as cmd command, Windows PowerShell or bash shell. The following describes how to run the command line through cmd.

Open the Run pop-up box in Windows and type the cmd command:

Or find cmd.exe from the start menu:

File into the command line interface to enter the folder where siteserver.exe, and then enter the siteserver.exe version command, the screen will display the version information:

C:\Windows\system32> siteserver version
欢迎使用 SiteServer CLI 命令行工具

SiteServer CLI 版本号: 6.9.0
当前文件夹: C:\Windows\system32

Now you can start backing up, restoring, upgrading, and more with the SiteServer CLI command line.

3. Set environment variables

If you want to run siteserver.exe in any folder, you can do so by setting the Windows environment variable, which is our recommended usage to run SiteServer commands anytime, anywhere.

First right click on my computer, select Properties in the pop-up menu, pop-up system interface, click Advanced System Settings in the system interface, pop-up advanced tab:

Click the environment variable button, edit the Path variable in the pop-up dialog box, and add the folder address where the siteserver.exe file is located:

Click OK and re-open the command line interface to run the siteserver command in any folder.