DataSpell 2021.3 Help

Command-line interface

Use DataSpell features from the command line: open files and projects, view diffs, merge files, apply code style formatting, and inspect the source code.

Launcher for a standalone instance

The installation directory contains batch scripts and executables for launching DataSpell, formatting the source code, and running inspections. To use them from the Command Prompt cmd.exe, add the location of the DataSpell bin folder to the PATH environment variable. For example, if you installed DataSpell to C:\Program Files\JetBrains\DataSpell, you can use the following command:

set PATH=%PATH%;C:\Program Files\JetBrains\DataSpell\bin

This command changes the PATH environment variable for the current shell only (the current instance of cmd.exe). If you want to update it permanently for the current user, run setx:

setx PATH "%PATH%;C:\Program Files\JetBrains\DataSpell\bin"

To update it system-wide for all users, run setx /M instead of setx.

After you configure the PATH variable, you can run the executable from any working directory in the Command Prompt: dataspell64.exe. Alternatively, you can use the batch script: dataspell.bat.

To run DataSpell from the shell, use the open command with the following options:

  • -a: specify the application.

  • --args: specify additional arguments when passing more than just the file or directory to open.

  • -n: open a new instance of the application even if one is already running.

For example, you can run DataSpell.app with the following command:

open -na "DataSpell.app"

You can create a shell script with this command in a directory from your PATH environment variable. For example, create the file /usr/local/bin/dataspell with the following contents:

#!/bin/sh open -na "DataSpell.app" --args "$@"

Make sure you have permissions to execute the script and since /usr/local/bin should be in the PATH environment variable by default, you should be able to run dataspell from anywhere in the shell.

On Linux, the installation directory contains the launcher shell script dataspell.sh under bin. For example, if you installed DataSpell to /opt/dataspell, you can run the script using the following command:

/opt/dataspell/bin/dataspell.sh

You can create a symbolic link to the launcher script in a directory from the PATH environment variable. For example, if you installed DataSpell to /opt/dataspell and want to create a link named dataspell in /usr/local/bin, run the following command:

ln -s /opt/dataspell/bin/dataspell.sh /usr/local/bin/dataspell

Since /usr/local/bin should be in the PATH environment variable by default, you should be able to run the dataspell command from anywhere in the shell.

Shell scripts generated by the Toolbox App

If you are using the Toolbox App to install and manage JetBrains products, it can create shell scripts for launching your IDEs from the command line.

Generate shell scripts

  1. Open the Toolbox App and click The screw nut icon in the top right corner.

  2. In the Toolbox App Settings, enable Generate shell scripts.

  3. If necessary, change the shell scripts location.

If you have several versions of the same IDE, the Toolbox App generates a shell script for each version with a unique name. You can change the name of the shell script for an IDE instance in the settings for this specific instance.

Change the name of the shell script

  1. Open the Toolbox App.

  2. Click The screw nut icon next to the relevant IDE instance and select Settings.

  3. At the bottom, change the Shell script name field.

By default, the Toolbox App puts shell scripts in a directory from the system PATH environment variable, so you can run the name of the script as a command to launch DataSpell from any working directory.

Command-line arguments

The launcher script accepts commands, options, and other arguments to modify its behavior:

Argument

Description

No argument

Launch DataSpell.

Commands

Options

nosplash

Do not show the splash screen when loading DataSpell.

dontReopenProjects

Do not reopen projects and show the welcome screen. This can help if a project that was open crashes DataSpell for some reason.

disableNonBundledPlugins

Do not load manually installed plugins. This can help if a plugin that you installed crashes DataSpell for some reason. You will be able to start the IDE and either disable or uninstall the problematic plugin.

--wait

Wait for the files to be closed before returning to the command prompt.

Last modified: 11 November 2021