Getting Started

Step 1 - Obtain an API Key

Obtain an API Key by visiting: https://fixinator.app

Step 2 - Download and Install Commandbox

Mac Users

If you are on a Mac with homebrew, simply run the following:

brew install commandbox

If you do not use homebrew please follow the Windows / Linux instructions below.

Windows / Linux

Download (box.exe) and add it to your system PATH (optional). ( Installation Instructions)

What is CommandBox?

CommandBox is a command line tool for CFML developers it is very powerful, fixinator uses it to write a command line tool to run scans. Learn More about CommandBox here.

Step 3 - Install the fixinator command

First make sure you have an API key (visit https://fixinator.app ), and have installed box (also know as CommandBox, see Step 2 above for details).

Now you can install the fixinator CommandBox command by running:

box install fixinator

in your Terminal or Command Prompt

Step 4 - Set your API key

You can set the API key by running the following command:

box config set modules.fixinator.api_key=YOUR_API_KEY

You can also set the API key by setting an environment variable named FIXINATOR_API_KEY

Step 5 - Scan Some Code

Now use the fixinator command to scan some code:

box fixinator path=/some/folder

Tips

You can just run box or box.exe without any arguments and then you will have a CommandBox shell. From the box shell you can cd to a directory and run the fixinator command. It will be faster to keep the box shell open, rather than starting / stopping box each time you run a scan.