How to use the command 'code' (with examples)

Visual Studio Code is a cross-platform and extensible code editor that is widely used by developers. The code command is a command-line tool that allows users to start Visual Studio Code from the terminal. It provides various options to open specific files, install and uninstall extensions, print installed extensions, and more.

Use case 1: Start Visual Studio Code

Code:

code

Motivation: This command is used to simply start Visual Studio Code from the terminal without any additional parameters. It is useful when you want to quickly open the editor to start working on your code.

Explanation:

• The code command without any arguments starts Visual Studio Code.
• When executed, it launches the editor, allowing you to write and edit code.

Example output:

• Visual Studio Code is launched, and the editor window appears on your computer screen.

Use case 2: Open specific files/directories

Code:

code path/to/file_or_directory1 path/to/file_or_directory2 ...

Motivation: This use case is handy when you want to open specific files or directories directly in Visual Studio Code. It allows you to quickly jump into editing the desired files or exploring the contents of a specific directory.

Explanation:

• By providing one or more file or directory paths as arguments, you can open them in Visual Studio Code.
• The editor will open each specified file or directory as separate tabs or sidebars, allowing you to work with them simultaneously.

Example output:

• Visual Studio Code is launched, and the specified files or directories are opened as separate tabs or sidebars within the editor.

Use case 3: Compare two specific files

Code:

code --diff path/to/file1 path/to/file2

Motivation: When you need to compare two specific files, this use case comes in handy. It allows you to view the differences between the two files side by side.

Explanation:

• The --diff flag is used to compare two specific files.
• By providing the paths of the two files as arguments, Visual Studio Code will open with a split view, displaying the differences between the files.

Example output:

• Visual Studio Code is launched, and a split view is displayed, showcasing the differences between the two specified files side by side.

Use case 4: Open specific files/directories in a new window

Code:

code --new-window path/to/file_or_directory1 path/to/file_or_directory2 ...

Motivation: This use case is useful when you want to open specific files or directories in a new instance of Visual Studio Code. It allows you to work on separate projects simultaneously.

Explanation:

• The --new-window flag opens the specified files or directories in a new window of Visual Studio Code.
• Each specified file or directory will open as separate tabs or sidebars in the new window.

Example output:

• A new instance of Visual Studio Code is launched, and the specified files or directories are opened as separate tabs or sidebars within the new window.

Use case 5: Install/uninstall a specific extension

Code:

code --install|uninstall-extension publisher.extension

Motivation: This use case allows you to install or uninstall a specific extension in Visual Studio Code. Extensions enhance the functionality of the editor and help tailor it to your specific needs.

Explanation:

• By using the --install-extension flag followed by the publisher and extension name, you can install a specific extension.
• Alternatively, by using the --uninstall-extension flag followed by the publisher and extension name, you can uninstall a specific extension.

Example output:

• The specified extension is installed or uninstalled in Visual Studio Code, and a success message is displayed.

Use case 6: Print installed extensions

Code:

code --list-extensions

Motivation: This use case is useful when you want to view a list of all the installed extensions in Visual Studio Code.

Explanation:

• The --list-extensions flag is used to print the names of the installed extensions.
• When executed, Visual Studio Code will list all the installed extensions in the terminal.

Example output:

• The terminal displays a list of the installed extensions in Visual Studio Code.

Use case 7: Print installed extensions with their versions

Code:

code --list-extensions --show-versions

Motivation: This use case allows you to view a list of all the installed extensions along with their versions in Visual Studio Code.

Explanation:

• The --show-versions flag is used in conjunction with the --list-extensions flag to print the names of the installed extensions along with their versions.
• When executed, Visual Studio Code will list all the installed extensions along with their respective versions in the terminal.

Example output:

• The terminal displays a list of the installed extensions and their versions in Visual Studio Code.

Use case 8: Start the editor as a superuser (root) while storing user data in a specific directory

Code:

sudo code --user-data-dir path/to/directory

Motivation: This use case is necessary when you need to run Visual Studio Code as a superuser (root) and store user data, such as configurations and extensions, in a specific directory. It allows you to work with administrative privileges while keeping your personal settings separate.

Explanation:

• The sudo command grants superuser privileges to the code command. This is required to run Visual Studio Code as a superuser (root).
• The --user-data-dir flag specifies the directory where user data, including configurations and extensions, should be stored.
• By providing the path to the desired directory as an argument, Visual Studio Code will use that directory for storing user data.

Example output:

• Visual Studio Code is launched with superuser privileges, and the user data is stored in the specified directory.
• The editor opens with the configurations and extensions specific to the superuser in use.