---
title: "Command Line Tool"
slug: "commandlinetool-1"
updated: 2026-05-18T05:37:28Z
published: 2026-05-18T05:37:28Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.12dsynergy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Command Line Tool

While the 12d Synergy CMD Line tool is not an API, it can be used in batch processing to automate tasks without programming in .NET.

Each of the commands below can be used from the Windows Command Prompt or from another calling application.

They have their own inputs, which are documented when the command is run.

The **format**to run them is:

"*c:\program files (x86)\12d\12d synergy\4.0\client\app\12dSynergyCmdLine.exe*" *COMMAND INPUTS*

If an input is more than one word (contains a space), it should be wrapped in quotes (“ “).

**Example of Syntax:**

*12dSynergyCmdLine.exe <action> -server <server> -user <username> -password <password> -job <job full path> -path <folder path within job>*

**Example of a GET ALL**:

*12dSynergyCmdLine.exe get -server localhost -user steve.smith -password Password1 -job "Jacaranda Company/Projects/20160001 - Emu Park" -path "03 Engineering/Letters"*

This would do a “**get all”** on the folder and store it in the workspace.

You can also run the program without any arguments to see the available commands for your version:

*12dSynergyCmdLine.exe*

Each command then has its own individual options. To view these, enter the command with no inputs or options as follows:

*12dSynergyCmdLine.exe List*

| Command | Description |
| --- | --- |
| CheckOut | Checks out a file, managed folder or 12d Model project |
| CheckIn | Checks in a file, managed folder or 12d Model project |
| CancelCheckOut | Cancels the checkout of a file, managed folder or 12d Model project |
| Add | Adds a new file |
| Get | Gets a file, managed folder or 12d model project |
| List | Lists the contents of a job or folder |
| CreateJob | Creates a new job |
| CreateFolder | Creates a new folder |
| GetJobName | Gets the job name from the current path in the workspace |
| Open | Opens a file |
| GetLocalPath | Gets the local path (a.k.a. workspace path) of a file, folder or 12d Model project |
| EditFolder | Updates information about a folder |
| FileInfo | Gets information about a given file |
| FolderInfo | Gets information about a given folder |
| Purge | Purge a file, managed folder or 12d Model project |
| Script | Accepts a text or console input for a set of these commands |
| FileListReport | Generates a File List Report on a job |
| AddFiles | Adds multiple files |
| GetProjectName | Gets the name of the project from the current path in the workspace |
| SetJobAttributes | Sets the job attributes |
| SyncConnector | Runs a manual connector sync |