efafef8495f030501e0df59ccb76a598bbce3ae1
- Author
- Marc Cornellà <marc@mcornella.com>
- Committer
- Marc Cornellà <marc@mcornella.com>
- Date
Message
docs: improve several plugin READMEs and add one for `ssh` plugin
Diff
This diff is truncated to protect this page.
1diff --git a/plugins/aliases/README.md b/plugins/aliases/README.md
2index 14f9c5c53765be878d4a478255ff84b09ef66233..5a7e7dfc6a63db2ce82c78efd2276e2bb3a81f6b 100644
3--- a/plugins/aliases/README.md
4+++ b/plugins/aliases/README.md
5@@ -1,7 +1,5 @@
6 # Aliases cheatsheet
7
8-**Maintainer:** [@hqingyi](https://github.com/hqingyi)
9-
10 With lots of 3rd-party amazing aliases installed, this plugin helps list the shortcuts
11 that are currently available based on the plugins you have enabled.
12
13@@ -13,6 +11,8 @@ plugins=(aliases)
14
15 Requirements: Python needs to be installed.
16
17+**Maintainer:** [@hqingyi](https://github.com/hqingyi)
18+
19 ## Usage
20
21 - `als`: show all aliases by group
22diff --git a/plugins/ansible/README.md b/plugins/ansible/README.md
23index dd0e1ce03ebcbd056013e255a71339096847cfdc..6a06962eebfa097d660ee6658cc34c5e13b26d9a 100644
24--- a/plugins/ansible/README.md
25+++ b/plugins/ansible/README.md
26@@ -1,7 +1,5 @@
27 # ansible plugin
28
29-## Introduction
30-
31 The `ansible plugin` adds several aliases for useful [ansible](https://docs.ansible.com/ansible/latest/index.html) commands and [aliases](#aliases).
32
33 To use it, add `ansible` to the plugins array of your zshrc file:
34diff --git a/plugins/arduino-cli/README.md b/plugins/arduino-cli/README.md
35index 91bda90672df92fc9084c55b09f1d45d437fb1ec..821d72bbf0b9c9c50c455c28dccc6acb69dc75c2 100644
36--- a/plugins/arduino-cli/README.md
37+++ b/plugins/arduino-cli/README.md
38@@ -1,6 +1,7 @@
39 # Arduino CLI plugin
40
41 This plugin adds completion for the [arduino-cli](https://github.com/arduino/arduino-cli) tool.
42+
43 To use it, add `arduino-cli` to the plugins array in your zshrc file:
44
45 ```zsh
46diff --git a/plugins/asdf/README.md b/plugins/asdf/README.md
47index f047860e2777896cdea7b7d82e15af84674ef731..4af69a75cd542a050a911b0060198793cff8d453 100644
48--- a/plugins/asdf/README.md
49+++ b/plugins/asdf/README.md
50@@ -1,7 +1,5 @@
51 ## asdf
52
53-**Maintainer:** [@RobLoach](https://github.com/RobLoach)
54-
55 Adds integration with [asdf](https://github.com/asdf-vm/asdf), the extendable version manager, with support for Ruby, Node.js, Elixir, Erlang and more.
56
57 ### Installation
58@@ -28,3 +26,7 @@ asdf install nodejs latest
59 asdf global nodejs latest
60 asdf local nodejs latest
61 ```
62+
63+### Maintainer
64+
65+- [@RobLoach](https://github.com/RobLoach)
66diff --git a/plugins/chucknorris/README.md b/plugins/chucknorris/README.md
67index b51875de9e52312a04f705ebfdda814bf3ac4a98..0562b3b59b31761053746f50f214fd04001ce470 100644
68--- a/plugins/chucknorris/README.md
69+++ b/plugins/chucknorris/README.md
70@@ -1,6 +1,6 @@
71 # chucknorris
72
73-Chuck Norris fortunes plugin for Oh My Zsh. Perfectly suitable as MOTD.
74+Fortunes plugin for Chuck Norris for Oh My Zsh. Perfectly suitable as MOTD.
75
76 To use it add `chucknorris` to the plugins array in you zshrc file.
77
78diff --git a/plugins/dbt/README.md b/plugins/dbt/README.md
79index e05d79cc322f082a2a5261e4bcd747cc23199844..74ae631cd42fd686bc74aa37b4a398292d560332 100644
80--- a/plugins/dbt/README.md
81+++ b/plugins/dbt/README.md
82@@ -1,13 +1,11 @@
83 # dbt plugin
84
85-## Introduction
86-
87 The `dbt plugin` adds several aliases for useful [dbt](https://docs.getdbt.com/) commands and
88 [aliases](#aliases).
89
90 To use it, add `dbt` to the plugins array of your zshrc file:
91
92-```
93+```zsh
94 plugins=(... dbt)
95 ```
96
97@@ -26,4 +24,4 @@ plugins=(... dbt)
98
99 ## Maintainer
100
101-### [msempere](https://github.com/msempere)
102+- [msempere](https://github.com/msempere)
103diff --git a/plugins/fancy-ctrl-z/README.md b/plugins/fancy-ctrl-z/README.md
104index 82a4fd75e724c4d199580e04f7d15e9169b39147..7766c51eb757a6f48af140696e118df800bc351a 100644
105--- a/plugins/fancy-ctrl-z/README.md
106+++ b/plugins/fancy-ctrl-z/README.md
107@@ -1,4 +1,14 @@
108-# Use Ctrl-Z to switch back to Vim
109+# fancy-ctrl-z
110+
111+Allows pressing Ctrl-Z again to switch back to a background job.
112+
113+To use it, add `fancy-ctrl-z` to the plugins array in your zshrc file:
114+
115+```zsh
116+plugins=(... fancy-ctrl-z)
117+```
118+
119+## Motivation
120
121 I frequently need to execute random commands in my shell. To achieve it I pause
122 Vim by pressing Ctrl-z, type command and press fg<Enter> to switch back to Vim.
123diff --git a/plugins/gatsby/README.md b/plugins/gatsby/README.md
124index 36846a228bb3241e40e3d868e845695a0a95e610..cc1bd392ef91eeefc0ea016b9a6e93be02e7b904 100644
125--- a/plugins/gatsby/README.md
126+++ b/plugins/gatsby/README.md
127@@ -1,6 +1,6 @@
128 # gatsby autocomplete plugin
129
130-* Adds autocomplete options for all gatsby commands.
131+Adds autocomplete options for all gatsby commands.
132
133 ## Requirements
134
135diff --git a/plugins/isodate/README.md b/plugins/isodate/README.md
136index 1ec75b2d47527773a94940fd267940e7f74fa39d..5329310c27e2bfb54f0fb14fef0a607b364655f2 100644
137--- a/plugins/isodate/README.md
138+++ b/plugins/isodate/README.md
139@@ -1,7 +1,5 @@
140 # Isodate plugin
141
142-**Maintainer:** [@Frani](https://github.com/frani)
143-
144 This plugin adds completion for the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601),
145 as well as some aliases for common Date commands.
146
147@@ -11,6 +9,8 @@ To use it, add `isodate` to the plugins array in your zshrc file:
148 plugins=(... isodate)
149 ```
150
151+**Maintainer:** [@Frani](https://github.com/frani)
152+
153 ## Aliases
154
155 | Alias | Command | Description |
156diff --git a/plugins/jira/README.md b/plugins/jira/README.md
157index 1c6930298c8871e2bcc933781e1f51b025905bfd..7cfb81b19c8c11902483249e1d5990177d7eb8c0 100644
158--- a/plugins/jira/README.md
159+++ b/plugins/jira/README.md
160@@ -1,16 +1,18 @@
161-# Jira plugin #
162+# Jira plugin
163
164-CLI support for JIRA interaction
165+This plugin provides command line tools for interacting with Atlassian's [JIRA](https://www.atlassian.com/software/jira) bug tracking software.
166
167-## Description ##
168+To use it, add `jira` to the plugins array in your zshrc file:
169
170-This plugin provides command line tools for interacting with Atlassian's [JIRA](https://www.atlassian.com/software/jira) bug tracking software.
171+```zsh
172+plugins=(... jira)
173+```
174
175 The interaction is all done through the web. No local installation of JIRA is necessary.
176
177 In this document, "JIRA" refers to the JIRA issue tracking server, and `jira` refers to the command this plugin supplies.
178
179-## Usage ##
180+## Usage
181
182 This plugin supplies one command, `jira`, through which all its features are exposed. Most forms of this command open a JIRA page in your web browser.
183
184@@ -18,19 +20,19 @@ This plugin supplies one command, `jira`, through which all its features are exp
185
186 `jira help` or `jira usage` will print the below usage instructions
187
188-| Command | Description |
189-| :------------ | :-------------------------------------------------------- |
190-| `jira` | Performs the default action |
191-| `jira new` | Opens a new Jira issue dialogue |
192-| `jira ABC-123` | Opens an existing issue |
193-| `jira ABC-123 m` | Opens an existing issue for adding a comment |
194-| `jira dashboard [rapid_view]` | Opens your JIRA dashboard |
195-| `jira mine` | Queries for your own issues |
196-| `jira tempo` | Opens your JIRA Tempo |
197-| `jira reported [username]` | Queries for issues reported by a user |
198-| `jira assigned [username]` | Queries for issues assigned to a user |
199-| `jira branch` | Opens an existing issue matching the current branch name |
200-| `jira help` | Prints usage instructions |
201+| Command | Description |
202+| :---------------------------- | :------------------------------------------------------- |
203+| `jira` | Performs the default action |
204+| `jira new` | Opens a new Jira issue dialogue |
205+| `jira ABC-123` | Opens an existing issue |
206+| `jira ABC-123 m` | Opens an existing issue for adding a comment |
207+| `jira dashboard [rapid_view]` | Opens your JIRA dashboard |
208+| `jira mine` | Queries for your own issues |
209+| `jira tempo` | Opens your JIRA Tempo |
210+| `jira reported [username]` | Queries for issues reported by a user |
211+| `jira assigned [username]` | Queries for issues assigned to a user |
212+| `jira branch` | Opens an existing issue matching the current branch name |
213+| `jira help` | Prints usage instructions |
214
215
216 ### Jira Branch usage notes
217@@ -43,7 +45,7 @@ This is also checks if the prefix is in the name, and adds it if not, so: "MP-12
218
219
220
221-#### Debugging usage ####
222+#### Debugging usage
223
224 These calling forms are for developers' use, and may change at any time.
225
226@@ -51,7 +53,7 @@ These calling forms are for developers' use, and may change at any time.
227 jira dumpconfig # displays the effective configuration
228 ```
229
230-## Setup ##
231+## Setup
232
233 The URL for your JIRA instance is set by `$JIRA_URL` or a `.jira_url` file.
234
235@@ -68,7 +70,7 @@ echo "https://jira.atlassian.com" >> .jira-url
236
237diff --git a/plugins/kube-ps1/README.md b/plugins/kube-ps1/README.md
238index dd49eff39967c5d0b3c1dda0ec7351c2b7df428d..be3c184be41a44e36f98b2c0e9afec210aeaf4e5 100644
239--- a/plugins/kube-ps1/README.md
240+++ b/plugins/kube-ps1/README.md
241@@ -1,5 +1,4 @@
242-kube-ps1: Kubernetes prompt for bash and zsh
243-============================================
244+# kube-ps1: Kubernetes prompt for bash and zsh
245
246 A script that lets you add the current Kubernetes context and namespace
247 configured on `kubectl` to your Bash/Zsh prompt strings (i.e. the `$PS1`).
248diff --git a/plugins/per-directory-history/README.md b/plugins/per-directory-history/README.md
249index 11150b05909f5d2a6a65221be10003c02d5d9b2d..2816c11ba5122cd9962472535cf2a9dfb36b0c6c 100644
250--- a/plugins/per-directory-history/README.md
251+++ b/plugins/per-directory-history/README.md
252@@ -1,5 +1,4 @@
253-per-directory-history plugin
254-----------------------------
255+# per-directory-history plugin
256
257 This plugin adds per-directory history for zsh, as well as a global history,
258 and the ability to toggle between them with a keyboard shortcut. This is a
259diff --git a/plugins/pipenv/README.md b/plugins/pipenv/README.md
260index e78ef0e3bb14fb888d56ce57414135a9fa3598c2..429b6f186b38b65bcea477c5c27e37ad69617ec4 100644
261--- a/plugins/pipenv/README.md
262+++ b/plugins/pipenv/README.md
263@@ -1,6 +1,6 @@
264 # Pipenv
265
266-## Installation
267+This plugin provides some features to simplify the use of [Pipenv](https://pipenv.pypa.io/) while working on ZSH.
268
269 In your `.zshrc` file, add `pipenv` to the plugins section
270
271@@ -10,8 +10,6 @@ plugins=(... pipenv ...)
272
273 ## Features
274
275-This plugin provides some features to simplify the use of Pipenv while working on ZSH.
276-
277 - Adds completion for pipenv
278 - Auto activates and deactivates pipenv shell
279 - Adds short aliases for common pipenv commands
280diff --git a/plugins/spring/README.md b/plugins/spring/README.md
281index 816181326a306ee9218a08ff095164acf72a8e61..b93402000dceef5c308bede47d37177d7798309e 100644
282--- a/plugins/spring/README.md
283+++ b/plugins/spring/README.md
284@@ -1,16 +1,12 @@
285 # Spring Boot oh-my-zsh plugin
286-oh-my-zsh Spring Boot plugin
287
288-## Spring Boot autocomplete plugin
289+Adds autocomplete options for all [Spring Boot](https://spring.io/projects/spring-boot) commands.
290
291-- Adds autocomplete options for all spring boot commands.
292+To use it, add `spring` to the plugins array in your zshrc file:
293
294-## Manual Install
295-
296- $ cd ~/.oh-my-zsh/plugins
297- $ git clone git@github.com:linux-china/oh-my-zsh-spring-boot-plugin.git spring
298-
299-Adjust your .zshrc file and add spring to plugins=(...)
300+```zsh
301+plugins=(... spring)
302+```
303
304 ## Tips
305
306diff --git a/plugins/ssh/README.md b/plugins/ssh/README.md
307new file mode 100644
308index 0000000000000000000000000000000000000000..3dd32ec7630ca3152f4fbb2e33a1ec4c06bbdf7f
309--- /dev/null
310+++ b/plugins/ssh/README.md
311@@ -0,0 +1,16 @@
312+# ssh plugin
313+
314+This plugin provides host completion based off of your `~/.ssh/config` file, and adds
315+some utility functions to work with SSH keys.
316+
317+To use it, add `ssh` to the plugins array in your zshrc file:
318+
319+```zsh
320+plugins=(... ssh)
321+```
322+
323+## Functions
324+
325+- `ssh_rmhkey`: remove host key from known hosts based on a host section name from `.ssh/config`.
326+- `ssh_load_key`: load SSH key into agent.
327+- `ssh_unload_key`: remove SSH key from agent.
328diff --git a/plugins/suse/README.md b/plugins/suse/README.md
329index f37ec1695f0bc2f3a648b4c8a854c6102920d5ff..e1e3aad29760923c358e7b6da7fcb1ddcbc33c76 100644
330--- a/plugins/suse/README.md
331+++ b/plugins/suse/README.md
332@@ -1,8 +1,6 @@
333 # suse
334
335-**Maintainer**: [r-darwish](https://github.com/r-darwish)
336-
337-Alias for Zypper according to the official Zypper's alias
338+Aliases for [Zypper](https://en.opensuse.org/Portal:Zypper) according to the official Zypper's alias
339
340 To use it add `suse` to the plugins array in you zshrc file.
341
342@@ -10,6 +8,8 @@ To use it add `suse` to the plugins array in you zshrc file.
343 plugins=(... suse)
344 ```
345
346+**Maintainer**: [r-darwish](https://github.com/r-darwish)
347+
348 ## Main commands
349
350 | Alias | Commands | Description |
351@@ -79,6 +79,7 @@ Related: [#9798](https://github.com/ohmyzsh/ohmyzsh/pull/9798).
352 | zrr | `sudo zypper rr` | remove repositories |
353
354 ## Services commands
355+
356 | Alias | Commands | Description |
357 | ----- | ------------------ | -------------------------------------------------------------- |
358 | zas | `sudo zypper as` | adds a service specified by URI to the system |
359@@ -88,6 +89,7 @@ Related: [#9798](https://github.com/ohmyzsh/ohmyzsh/pull/9798).
360 | zls | `zypper ls` | list services defined on the system |
361
362 ## Package Locks Management commands
363+
364 | Alias | Commands | Description |
365 | ----- | ---------------- | ----------------------------------- |
366 | zal | `sudo zypper al` | add a package lock |
367diff --git a/plugins/swiftpm/README.md b/plugins/swiftpm/README.md
368index e5b4752e435980442e0b964468f1e45ce334321b..babbf4d6662874825fae9350fbb721e3a3aef2f5 100644
369--- a/plugins/swiftpm/README.md
370+++ b/plugins/swiftpm/README.md
371@@ -1,7 +1,5 @@
372 # Swift Package Manager
373
374-## Description
375-
376 This plugin provides a few utilities that make you faster on your daily work with the [Swift Package Manager](https://github.com/apple/swift-package-manager), as well as autocompletion for Swift 5.9.
377
378 To start using it, add the `swiftpm` plugin to your `plugins` array in `~/.zshrc`:
379diff --git a/plugins/vagrant-prompt/README.md b/plugins/vagrant-prompt/README.md
380index dd0ca363be668c0268ae298987dd3c0a29707ad9..0720f4bdea66b708d0daf2b42f2721ba533e21e9 100644
381--- a/plugins/vagrant-prompt/README.md
382+++ b/plugins/vagrant-prompt/README.md
383@@ -1,6 +1,33 @@
384+# vagrant-prompt
385+
386 This plugin prompts the status of the Vagrant VMs. It supports single-host and
387 multi-host configurations as well.
388
389-Look inside the source for documentation about custom variables.
390+To use it, add `vagrant-prompt` to the plugins array in your zshrc file:
391+
392+```zsh
393+plugins=(... vagrant-prompt)
394+```
395+
396+**Alberto Re <alberto.re@gmail.com>**
397+
398+## Usage
399+
400+To display Vagrant info on your prompt add the `vagrant_prompt_info` to the
401+`$PROMPT` or `$RPROMPT` variable in your theme. Example:
402+
403+```zsh
404+PROMPT='%{$fg[$NCOLOR]%}%B%n%b%{$reset_color%}:%{$fg[blue]%}%B%c/%b%{$reset_color%} $(vagrant_prompt_info)$(svn_prompt_info)$(git_prompt_info)%(!.#.$) '
405+```
406+
407+`vagrant_prompt_info` makes use of some custom variables. This is an example
408+definition:
409
410-Alberto Re <alberto.re@gmail.com>
411+```zsh
412+ZSH_THEME_VAGRANT_PROMPT_PREFIX="%{$fg_bold[blue]%}["
413+ZSH_THEME_VAGRANT_PROMPT_SUFFIX="%{$fg_bold[blue]%}]%{$reset_color%} "
414+ZSH_THEME_VAGRANT_PROMPT_RUNNING="%{$fg_no_bold[green]%}●"
415+ZSH_THEME_VAGRANT_PROMPT_POWEROFF="%{$fg_no_bold[red]%}●"
416+ZSH_THEME_VAGRANT_PROMPT_SUSPENDED="%{$fg_no_bold[yellow]%}●"
417+ZSH_THEME_VAGRANT_PROMPT_NOT_CREATED="%{$fg_no_bold[white]%}○"
418+```
419diff --git a/plugins/vagrant-prompt/vagrant-prompt.plugin.zsh b/plugins/vagrant-prompt/vagrant-prompt.plugin.zsh
420index d7c76c3c965bfbf7a5108ac83698bc87a1c92b0d..29f4038c5169bb129856bd26f6d6f01a688bb217 100644
421--- a/plugins/vagrant-prompt/vagrant-prompt.plugin.zsh
422+++ b/plugins/vagrant-prompt/vagrant-prompt.plugin.zsh
423@@ -1,20 +1,3 @@
424-# vim:ft=zsh ts=2 sw=2 sts=2
425-#
426-# To display Vagrant infos on your prompt add the vagrant_prompt_info to the
427-# $PROMPT variable in your theme. Example:
428-#
429-# PROMPT='%{$fg[$NCOLOR]%}%B%n%b%{$reset_color%}:%{$fg[blue]%}%B%c/%b%{$reset_color%} $(vagrant_prompt_info)$(svn_prompt_info)$(git_prompt_info)%(!.#.$) '
430-#
431-# `vagrant_prompt_info` makes use of some custom variables. This is an example
432-# definition:
433-#
434-# ZSH_THEME_VAGRANT_PROMPT_PREFIX="%{$fg_bold[blue]%}["
435-# ZSH_THEME_VAGRANT_PROMPT_SUFFIX="%{$fg_bold[blue]%}]%{$reset_color%} "
436-# ZSH_THEME_VAGRANT_PROMPT_RUNNING="%{$fg_no_bold[green]%}●"
437-# ZSH_THEME_VAGRANT_PROMPT_POWEROFF="%{$fg_no_bold[red]%}●"
438-# ZSH_THEME_VAGRANT_PROMPT_SUSPENDED="%{$fg_no_bold[yellow]%}●"
439-# ZSH_THEME_VAGRANT_PROMPT_NOT_CREATED="%{$fg_no_bold[white]%}○"
440-
441 function vagrant_prompt_info() {
442 local vm_states vm_state
443 if [[ -d .vagrant && -f Vagrantfile ]]; then
444diff --git a/plugins/vim-interaction/README.md b/plugins/vim-interaction/README.md
445index c2b45f1d897bd8a4d7c2221b6c906918e2e19d6a..437b48d990234154971b74fe6f3db7086ef3ee67 100644
446--- a/plugins/vim-interaction/README.md
447+++ b/plugins/vim-interaction/README.md
448@@ -1,5 +1,13 @@
449 # Vim Interaction #
450
451+The idea for this script is to give you some decent interaction with a running
452+GVim session. Normally you'll be running around your filesystem doing any
453+number of amazing things and you'll need to load some files into GVim for
454+editing, inspecting, destruction, or other bits of mayhem. This script lets you
455+do that.
456+
457+## Usage
458+
459 The plugin presents a function called `callvim` whose usage is:
460
461 usage: callvim [-b cmd] [-a cmd] [file ... fileN]
462@@ -9,14 +17,6 @@ The plugin presents a function called `callvim` whose usage is:
463 file The file to edit
464 ... fileN The other files to add to the argslist
465
466-## Rationale ##
467-
468-The idea for this script is to give you some decent interaction with a running
469-GVim session. Normally you'll be running around your filesystem doing any
470-number of amazing things and you'll need to load some files into GVim for
471-editing, inspecting, destruction, or other bits of mayhem. This script lets you
472-do that.
473-
474 ## Aliases ##
475
476 There are a few aliases presented as well:
477diff --git a/plugins/xcode/README.md b/plugins/xcode/README.md
478index 27d6a228b62f02c0857f362bd55db68d50d3592d..ac79f728dbdec3f7ba14b697e5a26bab9a4aecc6 100644
479--- a/plugins/xcode/README.md
480+++ b/plugins/xcode/README.md
481@@ -1,7 +1,5 @@
482 # Xcode
483
484-## Description
485-
486 This plugin provides a few utilities that can help you on your daily use of Xcode and iOS development.
487
488 To start using it, add the `xcode` plugin to your `plugins` array in `~/.zshrc`:
489diff --git a/plugins/yii2/README.md b/plugins/yii2/README.md
490index 345b66eb61faf883985de78d84860267d25d49b9..e6c71f23ee3196ee6a318f32af0c422a1ab28c1b 100644
491--- a/plugins/yii2/README.md
492+++ b/plugins/yii2/README.md
493@@ -1,7 +1,7 @@
494 # Yii2 autocomplete plugin
495
496-* Adds autocomplete commands and subcommands for yii.
497+Adds autocomplete commands and subcommands for [yii](https://www.yiiframework.com/).
498
499 ## Requirements
500
501-Autocomplete works from directory where your `yii` file contains.
502+Autocomplete works from directory where your `yii` file is contained.
503diff --git a/plugins/zsh-interactive-cd/README.md b/plugins/zsh-interactive-cd/README.md
504index 4bffbf04af7eb312da6d74adffb78aedc08fbf74..29812a2957b0dd5100c22212770aa96bb8f0577a 100644
505--- a/plugins/zsh-interactive-cd/README.md
506+++ b/plugins/zsh-interactive-cd/README.md
507@@ -1,5 +1,7 @@
508 # zsh-interactive-cd
509
510+This plugin provides an interactive way to change directories in zsh using fzf.
511+
512 ## Demo
513
514 
515@@ -8,7 +10,11 @@
516
517 1. Install [fzf](https://github.com/junegunn/fzf) by following its [installation instruction](https://github.com/junegunn/fzf#installation).
518
519-2. Source `zsh-interactive-cd.plugin.zsh` in `.zshrc`.
520+2. Add `zsh-interactive-cd` to your plugin list in `~/.zshrc`:
521+
522+ ```zsh
523+ plugins=(... zsh-interactive-cd)
524+ ```
525
526 ## Usage
527