vscli

A CLI tool to launch vscode projects, which supports devcontainers.

Features

• A shorthand for launching vscode projects
• Detects whether a project is a devcontainers project, and launches the devcontainer instead
• Supports the insiders version of vscode

Installation

Cargo

Install vscli using cargo on Windows or Linux:

cargo install vscli

Homebrew

Install vscli using brew on Linux:

brew install michidk/tools/vscli

Additional steps

You can set a shorthand alias for vscli in your shell's configuration file:

alias vs="vscli --insiders"

Usage

Commandline

After installation, the vscli command will be available:

USAGE:
    vscli [FLAGS] [OPTIONS] <path> [args]...

FLAGS:
    -h, --help        Prints help information
    -i, --insiders    Whether to launch the insiders version of vscode
    -V, --version     Prints version information

OPTIONS:
    -b, --behaviour <behaviour>    Launch behaviour [default: detect]  [possible values: detect, force-container, force-classic]
    -v, --verbosity <verbosity>    The verbosity of the output [default: info]  [possible values: off, error, warn, info, debug, trace]

ARGS:
    <path>       The path of the vscode project to open [default: .]
    <args>...    Aditional arguments to pass to vscode

This help is also available using the --help flag:

Examples

You can launch a project using the default behaviour:

vscli                               # open vscode in the current directory
vscli .                             # open vscode in the current directory
vscli /path/to/project              # open vscode in the specified directory

The default behaviour tries to dectect whether the project is a devcontainers project. If it is, it will launch the devcontainer instead - if not it will launch vscode normally.

You can change the launch behvaiour using the --behaviour flag:

vscli --behaviour force-container . # force open vscode devcontainer (even if vscli did not detect a devcontainer)
vscli --behaviour force-classic .   # force open vscode without a devcontairer (even if vscli did detect a devcontainer)

You can launch the insiders version of vscode using the --insiders flag:

vscli --insiders .                  # open vscode insiders in the current directory