CLI

Describes the Philter Studio command line interface (CLI).

CLI Overview

The Philter Studio command line interface (CLI) lets you filter files and documents from the command line without having to use the Philter Studio user interface. The purpose of the CLI is to provide an interface to Philter on Windows desktops that can be used through scripts or integrated with other applications.

The Philter Studio executable is named PhilterStudioCLI.exe and is located in Philter Studio's installation directory. The installation directory is C:\Program Files\Philter Studio unless a different folder was selected during the setup.

The Philter Studio CLI only runs on Windows. For a CLI for interacting with Philter on other operating systems, see the philter-cli project.

CLI Usage

The usage examples shown below assume we have changed to the working directory C:\Program Files\Philter Studio.

Running PhilterStudioCLI.exe without any parameters will show the usage details:

$ PhilterStudioCLI.exe
2020-04-01 11:17:34,674 INFO PhilterStudio.CLI - Starting Philter Studio CLI 1.0.0.0
Philter Studio CLI 1.0.0.0
Copyright (c) 2020 Mountain Fog, Inc.
ERROR(S):
Required option 'f, filenames' is missing.
-v, --verbose Set output to verbose messages.
-c, --context The filtering context.
-p, --profile The name of the filter profile.
-h, --host The Philter host.
-i, --ignoreSsl Ignore certificate validation errors.
-f, --filenames Required. One or more files to process.
--help Display this help screen.
--version Display version information.

Filtering Files and Documents

The file(s) to filter must be of the types .txt, .doc, or .docx.

The only required parameter is -f which is the file name to filter:

PhilterStudioCLI.exe -h https://192.168.1.1:8080 -f c:\file.txt

Multiple files can be specified by listing them:

PhilterStudioCLI.exe -h https://192.168.1.1:8080 -f c:\file1.txt c:\file2.txt c:\file3.txt

The two above examples will send the file or document to Philter using the context none and the filter profile default. To specify a context and a filter profile we can use the -c and -p options, respectively:

PhilterStudioCLI.exe -h https://192.168.1.1:8080 -f c:\file.txt -c my-context -p my-filter-profile

The filtered file or document will be written to the same folder that contains the input file with _filtered appended to the file name. For example, for an input file c:\My Documents\file.txt, the filtered file will be written to c:\My Documents\file_filtered.txt.

Parameters

Required Parameters

These parameters are required when running PhilterStudioCLI.exe.

Parameter

Example Usage

Description

-f

-f <file> <file> <file>

Specifies one or more files or documents to process.

Optional Parameters

These parameters are optional when running PhilterStudioCLI.exe.

Parameter

Example Usage

Description

-v

-v

Enables verbose output. Use this option to get more insight into what is happening to assist with troubleshooting.

-c

-c <context-name>

Specifies the context. If not provided, the default context is retrieved from Philter Studio's settings.

-p

-p <filter-profile-name>

Specifies the filter profile. If not provided, the default filter profile name is retrieved from Philter Studio's settings.

-h

-h <philter-host>

Specifies the Philter host, e.g. https://192.168.1.10:8080. If not provided, the Philter host configured in Philter Studio's settings is used.

-i

-i

Disables certificate validation errors when communicating with Philter. This is intended only for development and test usage.