The Freshworks Command-Line Interface (CLI) enables you to build, test, and package apps that are published to the Marketplace.

To view the list of CLI commands, after you install the CLI, at the command prompt type fdk and press Enter.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
❯ fdk
Usage: fdk [global-flag] [command] [command-flags] [arguments]

The Freshworks CLI enables you to build, test and publish apps on Freshworks Developer Platform

Options:
  -v, --version              prints the current version
  -u, --skip-update-check    Skips daily check for new cli versions
  -d, --app-dir <directory>  directory is the path to the directory where the app will be created. If this option is not specified, the app
                             will be created in the current directory.
  -h, --help                 display help for command

Commands:
  create [options]           Creates a new app based on the specified options
  generate                   Generates configuration files for the app
  run [options]              Runs the app on a local server for testing
  validate [options]         Validates the app code
  pack [options]             Creates the app package that can be submitted to the Marketplace
  version                    Display installed and latest version
  search [options] <phrase>  Searches our developer community for a specified post
  test [options]             Run tests defined for the current app
  help [command]             display help for command

ℹ For complete documentation please visit: https://freshworks.dev/ and navigate to the Documentation section.

• To view the information about a CLI command, run the following command. $ fdk COMMAND (-h | --help) Copied Copy

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  ❯ fdk create -h
  Usage: fdk create [options]
  
  Creates a new app based on the specified options
  
  Options:
    -p, --product <product>    where product is a Freshworks product. If this option is not specified, a prompt is displayed with the list of
                               supported products.
    -t, --template <template>  where template is the name of one of the templates that can be used as a starting point for development. If this
                               option is not specified, a prompt is displayed with the list of supported templates for the given product.
    -h, --help                 display help for command
  
  EXAMPLE:
    $ fdk create
    $ fdk create --product freshservice --template your_first_app
    $ fdk create --app-dir /Users/user/myfirstapp
  
  ℹ For complete documentation please visit: https://freshworks.dev/ and navigate to the Documentation section.

  EXPAND ↓
  
• To obtain detailed logs, run the following command. $ NODE_DEBUG=fdk fdk COMMAND

Version update lifecycle

When you run the Freshworks CLI commands, if no version update check has run in the last 24 hours, the FDK:

1. Checks whether a new FDK version is available.
2. If a new version is available and if you are not on the latest version, displays an update prompt that enables you to move to the latest version.
3. Keeps track of the update check time.

To prevent the FDK from checking for version updates, you can use the --skip-update-check option, along with the CLI commands, as follows:

Create

The command creates an app in the specified directory, based on the default app template. If no directory is specified, the app is created in the current directory.

Example 1
To create a Freshcaller app in the current directory, run the following command. Before you run the command, ensure that the current directory is empty. $ fdk create --products freshcaller

Sample Output
A Freshcaller app is created based on the your_first_app template, with the following files.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<current_app_directory>
├── README.md
├── app
│   ├── app.js
│   ├── freshcaller_logo.png
│   ├── icon.svg
│   ├── logo.png
│   ├── style.css
│   └── template.html
├── config
│   ├── iparam_test_data.json
│   └── iparams.json
└── manifest.json

2 directories, 9 files

Example 2
To create a Freshcaller app in the myfirstapp directory, run one of the following commands. Before you run the command, ensure that the myfirstapp directory is empty. $ fdk create --app-dir ./myfirstapp $ fdk create --app-dir /Users/user/myfirstapp

Output
The app files are created under the /Users/user/myfirstapp directory.

Generate

This command is used to generate app files with a specific template for an existing app that was created by using the create command.

• After you create an app, run the following command. $ fdk generate The list of the following files is displayed.
• oauth_config.json: Contains the configuration parameters, such as client_id, client_secret, authorize_url, token_url, and account/agent scope, required for OAuth-based authentication.
• iparams.json: Contains the installation parameters, such as iparam name and type of iparam, whose values are set when the app is installed.
• iparams.html: Contains the html code to build the Custom Installation page. You can enter the page title, select the product css to link, and choose to add jquery, fresh_client.js, and iparam.js and iparam.css.
• server.js: Contains the event registration and callback methods. You need to enter the names of the events and callback functions.
• manifest.json: Contains app information such as version, product, location, and so on. You need to select the product and app location.
• Select a file and enter the appropriate parameter values. The corresponding file is generated based on the values.

Run

The run command starts the local server, deploys the app project on the server, and enables you to test the app.

1
$fdk run -d <DIR>

1
$fdk run --app-dir <DIR>

1
$fdk run -d /user/myFirstApp

1
$fdk run -V <Validation-type>

1
$fdk run --skip-validation <Validation-type>

1
$fdk run -V lint

After testing, press Control + C to stop the server. A code coverage summary that indicates the extent of testing is displayed. A coverage summary that indicates extensive testing is as follows.

1
2
3
4
5
6
======================= Coverage summary ========================
    Statements   : 98.18% ( 54/55 )
    Branches     : 100% ( 4/4 )
    Functions    : 84.62% ( 22/26 )
    Lines        : 98.18% ( 54/55 )
    =================================================================

Example 1
To deploy the app project located in the current directory, run the following command. $ fdk run

Output

Example 2
To deploy the app project located in the myfirstapp directory, run the following command. $ fdk run --app-dir /Users/user/myfirstapp The output is the same as that for Example 1.

Configurable parameter

Validate

Note: Ensure to install or update to the latest FDK version.

This command validates whether the app code is error free. If there are errors in the code, corresponding violations are displayed after the command is run.

1
$fdk validate -d <DIR>

1
$fdk validate --app-dir <DIR>

1
$fdk validate -d /user/myFirstApp

1
$fdk validate -f

1
$fdk validate –fix

1
$fdk validate -f -d /users/myFirstApp

1
$fdk validate -V <Validation-type>

1
$fdk validate --skip-validation <Validation-type>

1
$fdk pack -V lint

The latest FDK version requires Node.js 14 or later versions. If you run the fdk validate command to validate an app built using an earlier (major) Node.js version and if your current Node.js runtime environment is 14 or later, the FDK displays a warning message and a prompt asking whether you want to continue. If you continue with the validation, the FDK:

1. Deletes the existing coverage folder. The folder contains the results of the fdk run command that is used to set up the local server and test an app.

2. Deletes the node_modules folder. The folder contains the npm dependencies (specified in manifest.json) that are installed when the fdk run command is run.

3. Includes or updates the engines attribute in manifest.json. The updated engines.node and engines.fdk values reflect the Node.js and FDK versions on which the app is validated.

After a successful validation, ensure to retest the app by using the fdk run command. The retesting generates the coverage folder and the coverage summary that is required to pack your app for submission.

If there is a minor Node.js version mismatch between the version used to build the app and the current Node.js runtime version, the FDK automatically updates manifest.json > engines.node to reflect the Node.js version on which the app is validated.

Pack

Note: Before packing, ensure to validate the app; resolve all Node.js version mismatch issues, if any.

The pack command creates an app package file that can be submitted for the app review process.

1
$fdk pack -d <DIR>

1
$fdk pack --app-dir <DIR>

1
$fdk pack -d /user/myFirstApp

1
$fdk pack -V <Validation-type>

1
$fdk pack --skip-validation <Validation-type>

1
$fdk pack -V lint

The command displays the Node.js and FDK versions that are used when packing the app.

After you run the pack command, a dist/<app_directory>.zip file is generated. To submit the app and get it published to Marketplace, upload the generated file to the Freshcaller developer portal.

Example 1
To pack the app files located in the current app project directory, run the following command. $ fdk pack

Output

Example 2
To pack the app project files located in the myfirstapp directory, run the following command. $ fdk pack --app-dir /Users/user/myfirstapp

Output

Version

The version command displays the installed and latest CLI version numbers. $ fdk version

Output

Test

The FDK includes a testing framework (currently in beta) to help test serverless apps. This enables you to write and maintain unit tests as part of app files. The test command runs these unit tests.

Search

The search command searches our developer community for all content relevant to the specified query-string (search phrase) and lists the links to the content. If the search finds appropriate WIKI articles, the articles are listed first and then other relevant content in the community are listed.

Example
$ fdk search Serverless app

Output

Test

The FDK includes a testing framework (currently in beta) to help test serverless apps. This enables you to write and maintain unit tests as part of app files. The test command runs these unit tests.