Adding formatting stuff to readme.
This commit is contained in:
parent
6703fc8b82
commit
aadd8c7458
@ -10,8 +10,7 @@
|
|||||||
|
|
||||||
[Description](#description) •
|
[Description](#description) •
|
||||||
[Installation](#installation) •
|
[Installation](#installation) •
|
||||||
[Options](#options) •
|
[Examples](#examples) •
|
||||||
[Example](#example) •
|
|
||||||
[Meta](#meta)
|
[Meta](#meta)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -36,50 +35,19 @@ You can install `extractwisdom` by executing this command.
|
|||||||
curl -sS https://raw.githubusercontent.com/danielmiessler/fabric/main/install.sh | bash
|
curl -sS https://raw.githubusercontent.com/danielmiessler/fabric/main/install.sh | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
## Examples
|
||||||
|
|
||||||
### Flags
|
Here are some examples of how to use `extractwisdom`.
|
||||||
|
|
||||||
When calling `extractwisdom`, the following flags are available:
|
|
||||||
|
|
||||||
- `--cmd`
|
|
||||||
- Changes the prefix of the `z` and `zi` commands.
|
|
||||||
- `--cmd j` would change the commands to (`j`, `ji`).
|
|
||||||
- `--cmd cd` would replace the `cd` command (doesn't work on Nushell / POSIX shells).
|
|
||||||
- `--hook <HOOK>`
|
|
||||||
- Changes how often zoxide increments a directory's score:
|
|
||||||
| Hook | Description |
|
|
||||||
| -------- | --------------------------------- |
|
|
||||||
| `none` | Never |
|
|
||||||
| `prompt` | At every shell prompt |
|
|
||||||
| `pwd` | Whenever the directory is changed |
|
|
||||||
- `--no-cmd`
|
|
||||||
- Prevents zoxide from defining the `z` and `zi` commands.
|
|
||||||
- These functions will still be available in your shell as `__zoxide_z` and
|
|
||||||
`__zoxide_zi`, should you choose to redefine them.
|
|
||||||
|
|
||||||
## Options
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
z foo # cd into highest ranked directory matching foo
|
z foo # cd into highest ranked directory matching foo
|
||||||
|
```
|
||||||
|
|
||||||
|
```sh
|
||||||
z foo bar # cd into highest ranked directory matching foo and bar
|
z foo bar # cd into highest ranked directory matching foo and bar
|
||||||
z foo / # cd into a subdirectory starting with foo
|
|
||||||
|
|
||||||
z ~/foo # z also works like a regular cd command
|
|
||||||
z foo/ # cd into relative path
|
|
||||||
z .. # cd one level up
|
|
||||||
z - # cd into previous directory
|
|
||||||
|
|
||||||
zi foo # cd with interactive selection (using fzf)
|
|
||||||
|
|
||||||
z foo<SPACE><TAB> # show interactive completions (zoxide v0.8.0+, bash 4.4+/fish/zsh only)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Meta
|
## Meta
|
||||||
|
|
||||||
- Author: Daniel Miessler
|
- Author: Daniel Miessler
|
||||||
- Published: January 5, 2024
|
- Published: January 5, 2024
|
||||||
|
|
||||||
Read more about the matching algorithm [here][algorithm-matching].
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user