Command Line Interface

Integrate SnowConvert for SQL Server into your CI/CD process with the CLI version of the tool.

This is a deprecated version of the SnowConvert documentation, please visit the official site HERE.

Quick start

To execute a conversion with the SnowConvert for SQL Server CLI you have to have an active license. Currently, the licenses for the CLI are different than the UI, but if you already have a license for the UI you should be able to reuse the same license key. In the section below we show how to install a license key.

There are several Command Line Arguments documented below, but the main ones are -i for the input folder and -o for the output folder.

Install a license

To install a license key just execute SnowConvert CLI program with the -l argument and the license key.

$: snowct-sqlserver -l P-ABCD-12345-EFGHI

Check license status

To install a license key just execute SnowConvert CLI program with just the -l and no other arguments.

$: snowct-sqlserver -l

Migrate a folder

To migrate a folder just execute SnowConvert CLI program with the -i <INPUT FOLDER> and -o <OUTPUT FOLDER> arguments.

$: snowct-sqlserver -i ~/Documents/Workspace/Code -o ~/Documents/Workspace/Output

CLI Arguments

Basic Conversion

-i, --input <PATH> (Required)

The path to the folder or file containing the input source code.

-o, --output <PATH> (Required)

The path to the output folder where the converted code and reports will be stored.

-a, --assessmentmode

Flag to indicate whether or not to generate only Assessment files. By default, it's set to FALSE.

--snowscript, --disableSnowScript (NO LONGER SUPPORTED)

Flags were used to indicate whether the migration tool should migrate stored procedures to Snowflake Scripting.

As of release 2.0.288. these flags are no longer supported. Please use the following flag instead:



Flag to indicate whether or not to preprocess or arrange the source code before its transformation. By default, it's set to FALSE.


Applies indentation to the original code and get it well organized.


Generates extra reports after the arrangement.


Applies arrangement to multiple databases represented as multiple folders, and keeps their original structure.

-e, --encoding <CODE PAGE>

The encoding code page number is used for parsing the source files. We only accept encodings supported by .NET Core. Here are the ones supported at the moment:

Code Page


Display Name






Unicode (Big endian)



Unicode (UTF-32)



Unicode (UTF-32 Big endian)






Western European (ISO)



Unicode (UTF-7). Not available in .NET 5



Unicode (UTF-8). Default encoding

-m, --comments

Flag to indicate if the user wants to comment on nodes that have missing dependencies.

Target Language

-t, --PLTargetLanguage <TARGET_LANGUAGE>

The string value specifies the target language to convert Stored procedures and Macros. Currently supported are: SnowScript and JavaScript. The default value is set to SnowScript.

Object Name Customization

-s, --customschema <SCHEMA_NAME>

The string value specifies the custom schema name to apply. If not specified, either PUBLIC or the original database name will be used. Example: DB1.MyCustomSchema.Table1.

If you provide this parameter with a schema name NONE --customschema none, the converted code will keep the original schema defined in the source code.

-d, --database <DB_NAME>

The string value specifies the custom database name to apply. Example: MyCustomDB.PUBLIC.Table1.


This flag must be used in conjunction with the -d or -s parameters. When used, it preserves the existing name qualification from the input code when previous parameters are used. Let's take a look at this example where -s newSchema was included:

SELECT * FROM mySchema.myObject;

The same applies to databases.

License and Help

-l, --license [<LICENSE_KEY>]

Shows the license information. If it's followed by a license key, it will attempt to download and install such a license. For example:

  • Showing license status snowct-sqlserver -l

  • Installing a license snowct-sqlserver -l 12345-ASDFG-67890


Show license terms information.


Display the help information.

Last updated