Download and Install Functionize CLI Overview

The Functionize CLI allows a user to connect with external tools more easily, such as Jenkins. The CLI is designed to work on both Windows and macOS/Linux machines. There are two core parts of the CLI:

• Tunnel setup: This allows a user to access local sites that are not publicly available over the internet

• Application commands: Functionize offers a robust set of command-line options to run tests, manage tests, create projects, users, and much more - these help you automate the usage of the application from systems such as CI/CD tools, onboarding tools, and more

Download the installer here.

API Credentials

Your Client ID and Client Secret will be required for configuration.

See links for Windows and macOS/Linux

These can be found by opening the User menu and selecting API Keys from the main Functionize dashboard.

Installation for macOS/Linux

1. Extract the installer zip file from link above
2. Open a Terminal window
3. Navigate to the extracted zip file
4. Run the following command in the Terminal window:

    source install.sh

5. The following result from the command will appear in the Terminal window:

   Installing Functionize CLI. Detected Mac(Linux) platform. Installation was successful

6. Please run the following command in the Terminal window to get started

   fze -h

7. Functionize is not yet recognized as a 'Trusted Developer' - at this point a user will receive a message that the process was killed and will get a pop-up window about not opening files from 'Untrusted Developers'
8. Click Cancel on the modal window explaining the untrusted status
9. Open System Preferences > Security & Privacy and click Allow Anyway
   
   
   
10. Return to the Terminal window and run the following command again:

    fze -h

11. A pop-up will open to confirm you want to open an app from an unidentified developer, click Open
12. The Functionize CLI Help library will appear with the main list of available Commands and Flags
13. Configure the .yaml file with your Client ID and Client Secret, see below
14. Run the following command in the Terminal window to generate an authentication token:
    

    fze token generate

Installation for Windows

1. Extract the installer zip file
2. Run the install.exe file
3. Enter Client ID and Client Secret from the API Keys menu, see above, as well as the Functionize end point, if needed
   Note: Installation will default to 'app.functionize.com' - if an option is not entered. This bypasses the need to manually edit the configuration file as shown below.
4. Follow the prompts in the installation wizard through to completion
5. Open a Windows Command Line window
6. Run the following command on the Command Line window:

    fze -h

7. The Functionize CLI Help library with the main list of available Commands and Flags
8. Run the following command on the Command Line window to generate the authentication token:
   

   fze token generate

Configuration File

For macOS and Linux users, you must manually add your Client ID and Client Secret from the API Keys menu, see above, as well as your Functionize end point to the configuration .yaml file. You can use the default file '.functionize-go-cli.yaml' or you can create your own.

1. Use your preferred text editor to open the .yaml file
2. Copy and paste the Client ID and Client Secret strings from the API Keys menu in Functionize
3. Enter the Functionize end point
   Note: Installation will default to 'app.functionize.com' - if an option is not entered.
4. Save and quit your text editor
5. Proceed to generating your authentication token