Crates.io | vscli |
lib.rs | vscli |
version | |
source | src |
created_at | 2023-03-05 09:45:36.836937+00 |
updated_at | 2025-02-23 18:42:50.805212+00 |
description | A CLI tool to launch vscode projects, which supports devcontainers. |
homepage | https://github.com/michidk/vscli |
repository | https://github.com/michidk/vscli |
max_upload_size | |
id | 801194 |
Cargo.toml error: | TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
size | 0 |
A CLI/TUI which makes it easy to launch Visual Studio Code (vscode) dev containers. Also supports other editors like Cursor.
Read here about the journey of reverse engineering Microsoft's dev container CLI in order to make this.
code
command but with dev container support)vscode
, vscode-insiders
, cursor
and other vscode forksInstall vscli using cargo on Windows or Linux:
cargo install vscli
Install vscli using homebrew on Linux or Mac:
brew install michidk/tools/vscli
Install vscli using Chocolatey on Windows:
choco install vscli
Install vscli using winget on Windows:
winget install vscli
You can set a shorthand alias for vscli
in your shell's configuration file:
alias vs="vscli open"
alias vsr="vscli recent"
After installation, the vscli
command will be available:
Usage: vscli [OPTIONS] <COMMAND>
Commands:
open Opens a dev container
recent Opens an interactive list of recently used workspaces
help Print this message or the help of the given subcommand(s)
Options:
-s, --history-path <HISTORY_PATH> Overwrite the default path to the history file [env: HISTORY_PATH=]
-d, --dry-run Whether to launch in dry-run mode (not actually open vscode) [env: DRY_RUN=]
-v, --verbose... Increase logging verbosity
-q, --quiet... Decrease logging verbosity
-h, --help Print help
-V, --version Print version
Opens a dev container.
Usage: vscli open [OPTIONS] [PATH] [ARGS]...
Arguments:
[PATH] The path of the vscode project to open [default: .]
[ARGS]... Additional arguments to pass to the editor [env: ARGS=]
Options:
-b, --behavior <BEHAVIOR> Launch behavior [possible values: detect, force-container, force-classic]
-s, --history-path <HISTORY_PATH> Overwrite the default path to the history file [env: HISTORY_PATH=]
-c, --config <CONFIG> Overwrites the path to the dev container config file [env: CONFIG=]
-d, --dry-run Whether to launch in dry-run mode [env: DRY_RUN=]
--command <COMMAND> The editor command to use (e.g. "code", "code-insiders", "cursor") [env: COMMAND=]
-v, --verbose... Increase logging verbosity
-q, --quiet... Decrease logging verbosity
-h, --help Print help
Opens an interactive list of recently used workspaces.
Usage: vscli recent [OPTIONS] [ARGS]...
Arguments:
[ARGS]... Additional arguments to pass to the editor [env: ARGS=]
Options:
-b, --behavior <BEHAVIOR> Launch behavior [possible values: detect, force-container, force-classic]
-s, --history-path <HISTORY_PATH> Overwrite the default path to the history file [env: HISTORY_PATH=]
-c, --config <CONFIG> Overwrites the path to the dev container config file [env: CONFIG=]
-d, --dry-run Whether to launch in dry-run mode [env: DRY_RUN=]
--command <COMMAND> The editor command to use (e.g. "code", "code-insiders", "cursor") [env: COMMAND=]
-v, --verbose... Increase logging verbosity
-q, --quiet... Decrease logging verbosity
-h, --help Print help
Both the open
and recent
commands share the same set of launch arguments, allowing you to customize how the editor is launched.
The following keybindings are available:
Key/Key Combination | Action | Description |
---|---|---|
Esc , Ctrl+Q or Ctrl+C |
Quit | Exits the application. |
Down or Ctrl+J |
Select Next | Moves to the next selectable item. |
Up or Ctrl+K |
Select Previous | Moves to the previous selectable item. |
KeypadBegin or Ctrl+1 |
Select First | Selects the first item. |
End or Ctrl+0 |
Select Last | Selects the last item. |
Enter or Ctrl+O |
Open Selected | Opens the currently selected item. |
Delete , Ctrl+R , or Ctrl+X |
Delete Selected Entry | Deletes the currently selected item. |
Note: If an input does not match any of the defined keybindings, it is treated as part of a search input.
There are three launch behaviors:
force-classic
: Launch vscode without a dev containerforce-container
: Launch vscode with a dev container, error if no dev container is founddetect
: Detect whether the project is a dev container project, and launch the dev container if it isThe detection algorithm determines which dev container config to launch.
--config
flag -> launch itYou can launch a project using the default behavior:
vscli open # open vscode in the current directory
vscli open . # open vscode in the current directory
vscli open /path/to/project # open vscode in the specified directory
The default behavior tries to detect whether the project is a dev container project. If it is, it will launch the dev container instead - if not it will launch vscode normally.
You can change the launch behavior using the --behavior
flag:
vscli open --behavior force-container . # force open vscode dev container (even if vscli did not detect a dev container)
vscli open --behavior force-classic . # force open vscode without a dev container (even if vscli did detect a dev container)
When you open a project containing more than one dev container config, you will be prompted to select one:
You can specify which editor command to use with the --command
flag:
vscli open --command cursor . # open using cursor editor
vscli open --command code . # open using vscode (default)
vscli open --command code-insiders . # open using vscode insiders
Additional arguments can be passed to the editor executable, by specifying them after --
:
vscli open . -- --disable-gpu # open the current directory without GPU hardware acceleration
Read more about the editor flags by executing code --help
(or cursor --help
, etc).
You can open a CLI-based user interface to display a list of recently opened projects using the recent
command:
vscli recent # open the CLI-based UI to select a recently opened project to open
vscli recent --command cursor # open the selected project with cursor, ignoring the editor stored in history
vscli recent --behavior force-container # force open the selected project in a dev container
vscli recent --command cursor --behavior detect # open with cursor and detect if dev container should be used
vscli recent --config .devcontainer/custom.json # open with a specific dev container config
vscli recent -- --disable-gpu # pass additional arguments to the editor
Both the open
and recent
commands support the same set of launch arguments:
--command
: Specify which editor command to use (e.g., "code", "code-insiders", "cursor")--behavior
: Set the launch behavior ("detect", "force-container", "force-classic")--config
: Override the path to the dev container config file--