Download and Install the Functionize CLI

The Functionize CLI allows you 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 you to access local sites that are not publicly available on the internet
• Application commands: we offer a robust set of command line options to run tests, manage tests, create projects, users, and so 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 below 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.
2. Open a Terminal window.
3. Navigate to the extracted zip file.
4. Run source install.sh
5. You should see "Installing Functionize CLI. Detected Mac(Linux) platform. Installation was successful. Please run 'fze -h' to get started."
6. Run fze -h
7. Functionize is not yet recognized as a "trusted developer" so at this point you 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 pop-up explaining the untrusted status.
9. Open System Preferences > Security & Privacy and click Allow Anyway.
   
10. Return to the Terminal window and run fze -h
11. A pop-up will open to confirm you want to open an app from an unidentified developer. Click Open.
12. You should see The Functionize CLI library 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 fze token generate (This command generates your authentication token.)

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 your Functionize End Point if needed. 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 to completion.
5. Open a Command Line window.
6. Run fze -h
7. You should see The Functionize CLI library with the main list of available Commands and Flags.
8. Run fze token generate (This command generates your authentication token.)

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 your Client ID and Client Secret strings from the API Keys menu in Functionize.
3. Enter your Functionize End Point. 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.