Snowpark Migration Accelerator: SMA CLI Walkthrough¶

Using the CLI¶

You can download the Command Line Interface (CLI) from the Download and Access section. Select the version that matches your operating system. You can store the CLI in any accessible location on your machine or container.

After downloading the package file (.zip or .tar format), extract its contents. The Command Line Interface (CLI) tool is located in the “orchestrator” folder within the extracted files.

Open a terminal or command prompt in the installation folder and verify the CLI installation by running the following command to check its version:

./sma –version

You will see results that look like this:

The SMA Command Line Interface (CLI) is a local application that runs on your computer, similar to the SMA desktop application. To analyze your code files using the SMA CLI, these files must be stored on your local machine where the CLI can access them. The CLI supports the same file types as the regular SMA application. For a complete list of supported file types, please refer to the supported filetypes in the SMA documentation.

The SMA documentation contains a complete list of CLI arguments. Let’s explore the most important ones in this section.

The SMA CLI runs in Conversion mode by default, rather than Assessment mode. To run the CLI in assessment mode, use the -a argument. For conversion operations, you’ll need a valid access code. To verify if you have a valid access code, use the following command:

./sma show-ac

If you need an access code, you can request one by following the instructions in the SMA documentation. After receiving the code by email, use the install access code parameter in the CLI to complete the installation.

To run a conversion, you need to provide:

1. Input directory (required)

2. Output directory (required)

If you haven’t created a project file before, you’ll also need to provide:

• User email

• Organization name

• Project name

Once you’ve set up these parameters for the first time, you only need to specify the input and output directories for future conversions.

./sma -i '/your/INput/directory/path/here' -o '/your/OUTput/directory/path/here' -e your@email.com -c Your-Organization -p Your-Project-Name

This screen displays a summary of your execution settings and prompts you to confirm whether you want to proceed.

To skip the confirmation prompt, add the –yes or -y parameter. This is particularly important when running the CLI from automated scripts.

The tool provides detailed progress information during its execution.

While the tool is running, it will continuously print output to the screen. When the process is complete, you will see the prompt again. The tool generates detailed output that includes all processes, issues, and completed or failed steps. You don’t need to read through all of this information while it’s running, as you can review it later in the Logs output folder.

Viewing the Output¶

The SMA CLI produces the same output as the SMA application. When you run the tool, it creates three folders in your specified output directory:

• Reports

• Logs

• Output (contains the converted code)

For detailed guidance on working with code that has been converted by the Snowpark Migration Accelerator (SMA), please refer to the conversion walkthrough.

Running the CLI Programmatically¶

Coming soon! The SMA team will provide a script that enables you to run the SMA Command Line Interface (CLI) automatically across multiple directories.

Try out the Command Line Interface (CLI) today. If you need help or have questions, contact the Snowpark Migration Accelerator team at sma-support@snowflake.com.