cPGuard Lite command line

cpgcli is the command line tool included with cPGuard. cPGuard Lite provides a number of helpful commands that enables you to use and configure cPGuard Lite even without a user interface.

Command syntax

To view a list of all available cpgcli commands, you may use the cpgcli --help command. Every command also has a “help” screen which displays and describes the command’s available options and variable. To view a help information, add  --help option to the command

Manage cPGuard License

# license command

To apply and manage cPGuard license on a server you can use  the license command. Use one of the options mentioned below with the command to apply, renew or remove license from a server.

--status

--key LICENSE-KEY

--renew

--remove

 
Example usage

Manage scanner engine

# scanner command

This command offers a convenient way for managing the automatic background virus scanner, allowing users to enable or disable its functionality, check its current operational status, and even restart the scanner if needed. This virus scanner operates behind the scenes to safeguard the system from potential threats.

--enable

--disable

--restart

Example usage

# cleanup command

Automatic file cleanup is a pivotal component designed to mitigate the impact of malware by automatically removing malicious code from infected files therby preventing your website or application from being broken or taken down. On identifying a feasible file, it can either be replaced from our CDN (core files of popular CMS, plugins, and themes), or be cleaned by our cleanup engine, leaving behind a sanitized version of the file.

--enable

--disable

# dailyscan command

The daily scan feature is designed to enhance the efficiency and effectiveness of malware detection by specifically targeting files under the watchlist that have been modified within the last 24 hours. By focusing on recently altered files, this optimizes scanning processes and ensures that the system remains protected against potential threats that may have been introduced recently but were skipped by cPGuard for any reason.

--enable

--disable

# weeklyscan command

The weekly scan feature is engineered to leave no stone unturned. It ensures the detection of malware threats that might otherwise remain hidden. By scanning (or re-scanning) only files under the watchlist that were modified in the last week, this feature optimizes the scanning process, saving time and system resources while ensuring that any newly introduced malicious content is promptly detected.

--enable

--disable

# watch command

View the list of directories under surveillance by the automated file scanner of cPGuard, and adjust the list by including or removing additional directories as needed.

--add

--remove

--list

--all

# file-action command

With this command, you can set the action the scanner engine should execute upon encountering infected files.

--virus action

--suspicious action

--binary action

Use one of the following actions : email, disable or quarantine

# whitelist command

Whitelisting a file involves adding the file to a trusted list, exempting it from being flagged as a potential threat during scans.

--user --list

--user --add user

--user --remove user

--file --list

--file --add filename

--file --remove filename

# blacklist command

Blacklisting a file makes the scanner treat it as suspicious or potentially harmful, causing the scanner to take specific actions when encountering it.

--file --list

--file --add filename

--file --remove filename

Manually scaning directories

# scan command

Whitelisting a file involves adding the file to a trusted list, exempting it from being flagged as a potential threat during scans.

--all

--path directory-path

--daily

--weekly

--virus-action action

--suspicious-action action

--binary-action action

You need not specify an action unless required. If unspecified, the main/default actions already set using cpgcli file-action will be used. Action can be one of the following : email, disable or quarantine

Example usage

View and take actions on scanner logs/results

# scanner-logs command

This command helps you access and analyze detailed scanner log entries, including identified threats, scan results, timestamps, and any actions taken on files. You can filter log entries based on various criteria, aiding in the prompt identification of potential security breaches.

--user user

--file 'filename or path'

--from 'time from'

--to 'time to'

--signature 'signature'

--export path

 
Example usage

# log-action command

Automatic file cleanup is a pivotal component designed to mitigate the impact of malware by automatically removing malicious code from infected files therby preventing your website or application from being broken or taken down. On identifying a feasible file, it can either be replaced from our CDN (core files of popular CMS, plugins, and themes), or be cleaned by our cleanup engine, leaving behind a sanitized version of the file.

--restore

--quarantine

--delete

--disable

--user user

--file 'filename or path'

--from 'time from'

--to 'time to'

--signature 'signature'

--scan-id ID

--log-id ID

You have to provide atleast one filter for log-action. Multiple log ID’s can be seperated using a comma or space

 Example usage 

IP reputation checks

# ip-reputation command

IP Reputation check feature conducts queries multiple DNSBL databases, which maintain lists of IP addresses that have been reported for malicious behavior or have shown a history of suspicious activities. A blacklisted IP address can imply that a client acount might be associated with spam, malware distribution, or other illicit activities.

--enable

--disable

--check IP

--result

--result IP

--add-ip IP

--remove-ip IP

--list-hosts

--list-hosts --available

--add-host hostname

--remove-host hostname

Configure email notifications

# notification command

Use the command to set up notification email alerts, ensuring timely communication of critical events, updates, and system status.

--primary-email email

--secondary-email email

--enable

--disable

--enable type1, type2

--disable type1, type2

--method

--method local

--method smtp

Supported types are virus, suspicious, binary, iprep, daily_report which stands for nofications on detection Virus files, Suspicious files, Binary file, IP reputation blacklist and Daily report

You will be prompted for SMTP configuration on choosing method smtp 

Manage IP whitelist

# ip command

This command lets you define a list of trusted IP addresses, ensuring that cPGuard does not block any request from these IP addresses.

--allow IP1 IP2..

--remove IP1 IP2..

--check IP

Report a file for review

# report command

The command facilitates the submission of false positive or suspicious files to us for review. Users can include contextual information regarding the file’s source, suspected activity, and potential impact as a description.

--false-positive filepath

--virus filepath

--desc 'description'

Export and import settings

# config command

The command facilitates the submission of false positive or suspicious files to us for review. Users can include contextual information regarding the file’s source, suspected activity, and potential impact as a description.

--export filename

--import 'filename or url'

OPSSHIELD support access

# support-access command

By using this command, you can grant server access to our qualified support personnel, facilitating efficient troubleshooting and issue resolution. The --grant command adds our ssh key to the root users ssh authorized_keys file.

--grant

--revoke

--status

cPGuard software update

# update command

You can use this command to check the availability of software updates and to update cPGuard software manually. This comes in handy when there are updates with important bug fixes or critical new features that you want applied immidiately on your server.

--export filename

--import 'filename or url'

In conclusion, this comprehensive help document hopes to provide detailed insights into the myriad command-line options available within our software, enabling you to easily manage various aspects cPGuard installed on your server.

We value user feedback and actively encourage you to communicate your suggestions, ideas, and needs for new features or improvements to our command-line functionalities.