Skip to content

Commit cb13cc5

Browse files
adamalstonadamalston
authored
docs(vscode): align README with current CLI behavior (ohmyzsh#13653)
1 parent 76ffd9e commit cb13cc5

1 file changed

Lines changed: 37 additions & 38 deletions

File tree

‎plugins/vscode/README.md‎

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# VS Code
22

3-
This plugin provides useful aliases to simplify the interaction between the command line and VS Code, VSCodium, or Cursor editor.
3+
This plugin provides useful aliases to simplify interaction between the command line and VS Code, VSCodium, or Cursor.
44

55
To start using it, add the `vscode` plugin to your `plugins` array in `~/.zshrc`:
66

@@ -10,46 +10,45 @@ plugins=(... vscode)
1010

1111
## Requirements
1212

13-
This plugin requires to have a flavour of VS Code installed and its executable available in PATH.
13+
This plugin requires one of the supported editors to be installed and its executable to be available in `PATH`.
1414

15-
You can install either:
15+
You can install one of the following:
1616

17-
- VS Code (code)
18-
- VS Code Insiders (code-insiders)
19-
- VSCodium (codium)
20-
- Cursor (cursor)
17+
- VS Code (`code`)
18+
- VS Code Insiders (`code-insiders`)
19+
- VSCodium (`codium`)
20+
- Cursor (`cursor`)
2121

22-
### MacOS
22+
### macOS
2323

24-
While Linux installations will add the executable to PATH, MacOS users might still have to do this manually:
24+
While Linux installations usually add the executable to `PATH`, macOS users might still have to do this manually:
2525

2626
[For VS Code and VS Code Insiders](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line),
27-
open the Command Palette via (F1 or ⇧⌘P) and type shell command to find the Shell Command:
27+
open the Command Palette with `F1` or `Shift+Cmd+P`, then search for the following command:
2828

2929
> Shell Command: Install 'code' command in PATH
3030
3131
[For VSCodium](https://github.com/VSCodium/vscodium/blob/master/DOCS.md#how-do-i-open-vscodium-from-the-terminal),
32-
open the Command Palette via (F1 or ⇧⌘P) and type shell command to find the Shell Command:
32+
open the Command Palette with `F1` or `Shift+Cmd+P`, then search for the following command:
3333

3434
> Shell Command: Install 'codium' command in PATH
3535
36-
For Cursor, open the Command Palette via (F1 or ⌘⇧P) and type shell command to find the Shell Command:
36+
For Cursor, open the Command Palette with `F1` or `Cmd+Shift+P`, then search for the following command:
3737

3838
> Shell Command: Install 'cursor' command in PATH
3939
40-
## Using multiple flavours
40+
## Choosing an editor
4141

42-
If for any reason, you ever require to use multiple flavours of VS Code i.e. VS Code (stable) and VS Code
43-
Insiders, you can manually specify the flavour's executable. Add the following line to the .zshrc file
44-
(between the `ZSH_THEME` and the `plugins=()` lines). This will make the plugin use your manually defined
45-
executable.
42+
If you have multiple supported editors installed, e.g., VS Code (stable) and VS Code Insiders, you can manually
43+
specify which executable the plugin should use. Add the following line to `~/.zshrc` between the `ZSH_THEME`
44+
and `plugins=()` lines. This makes the plugin use your manually defined executable.
4645

4746
```zsh
4847
ZSH_THEME=...
4948

50-
# Choose between one [code, code-insiders, codium, or cursor]
51-
# The following line will make the plugin to open VS Code Insiders
52-
# Invalid entries will be ignored, no aliases will be added
49+
# Choose one of `code`, `code-insiders`, `codium`, or `cursor`.
50+
# The following line makes the plugin open VS Code Insiders.
51+
# Invalid entries are ignored and no aliases are added.
5352
VSCODE=code-insiders
5453

5554
plugins=(... vscode)
@@ -61,29 +60,29 @@ source $ZSH/oh-my-zsh.sh
6160

6261
| Alias | Command | Description |
6362
| ----------------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
64-
| vsc | code . | Open the current folder in VS code |
65-
| vsc `dir` | code `dir` | Open passed folder in VS code |
66-
| vsca `dir` | code --add `dir` | Add folder(s) to the last active window |
63+
| vsc | code . | Open the current folder in VS Code |
64+
| vsc `[args ...]` | code `[args ...]` | Pass arguments through to VS Code, e.g., a file, folder, or CLI flags. |
65+
| vsca `dir` | code --add `dir` | Add one or more folders to the last active window. |
6766
| vscd `file` `file` | code --diff `file` `file` | Compare two files with each other. |
6867
| vscg `file:line[:char]` | code --goto `file:line[:char]` | Open a file at the path on the specified line and character position. |
69-
| vscn | code --new-window | Force to open a new window. |
70-
| vscr | code --reuse-window | Force to open a file or folder in the last active window. |
68+
| vscn | code --new-window | Force opening in a new window. |
69+
| vscr | code --reuse-window | Force opening a file or folder in the last active window. |
7170
| vscw | code --wait | Wait for the files to be closed before returning. |
72-
| vscu `dir` | code --user-data-dir `dir` | Specifies the directory that user data is kept in. Can be used to open multiple distinct instances of Code. |
71+
| vscu `dir` | code --user-data-dir `dir` | Specifies the directory where user data is stored. Can be used to open multiple distinct instances of Code. |
7372
| vscp `profile` | code --profile `profile` | Specifies the profile to open Code with. |
7473

75-
## Extensions aliases
74+
## Extension aliases
7675

77-
| Alias | Command | Description |
78-
| ----------------------- | ---------------------------------------------------------------- | --------------------------------- |
79-
| vsced `dir` | code --extensions-dir `dir` | Set the root path for extensions. |
80-
| vscie `id or vsix-path` | code --install-extension `extension-id> or <extension-vsix-path` | Installs an extension. |
81-
| vscue `id or vsix-path` | code --uninstall-extension `id or vsix-path` | Uninstalls an extension. |
76+
| Alias | Command | Description |
77+
| --------------------------- | ---------------------------------------------- | -------------------------------------- |
78+
| vsced `dir` | code --extensions-dir `dir` | Set the root directory for extensions. |
79+
| vscie `ext-id or vsix-path` | code --install-extension `ext-id or vsix-path` | Installs or updates an extension. |
80+
| vscue `ext-id` | code --uninstall-extension `ext-id` | Uninstalls an extension. |
8281

83-
## Other options:
82+
## Other options
8483

85-
| Alias | Command | Description |
86-
| ------------ | ------------------------- | --------------------------------------------------------------------------------------------------------------------- |
87-
| vscv | code --verbose | Print verbose output (implies --wait). |
88-
| vscl `level` | code --log `level` | Log level to use. Default is 'info'. Allowed values are 'critical', 'error', 'warn', 'info', 'debug', 'trace', 'off'. |
89-
| vscde | code --disable-extensions | Disable all installed extensions. |
84+
| Alias | Command | Description |
85+
| ------------ | ------------------------- | ---------------------------------------- |
86+
| vscv | code --verbose | Print verbose output (implies `--wait`). |
87+
| vscl `level` | code --log `level` | Log level to use. Default is `info`. |
88+
| vscde | code --disable-extensions | Disable all installed extensions. |

0 commit comments

Comments
 (0)