From 19176bb591884cf0a7100929730bd9f40fe0cb15 Mon Sep 17 00:00:00 2001 From: Anirudh Gupta <146579014+AnirudhG07@users.noreply.github.com> Date: Sat, 17 Aug 2024 00:40:28 +0530 Subject: [PATCH 01/10] docs: custom-shell.yazi desc add --- docs/resources.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources.md b/docs/resources.md index 4a01c040..282cb527 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -141,7 +141,7 @@ Vim: ## ๐Ÿš Shell plugins {#shell} - [yazi-prompt.sh](https://github.com/Sonico98/yazi-prompt.sh) - Display an indicator in your prompt when running inside a yazi subshell. -- [custom-shell.yazi](https://github.com/AnirudhG07/custom-shell.yazi) - Set your custom-shell as your default yazi Shell. +- [custom-shell.yazi](https://github.com/AnirudhG07/custom-shell.yazi) - Set your custom-shell as your default yazi Shell and run any custom command through any shell. - [command.yazi](https://github.com/KKV9/command.yazi) - Display a prompt for executing yazi commands. ## ๐Ÿ› ๏ธ Utilities {#utilities} From 8fdf0c4c72cb22b28ebdc944158b3bf223d9b2bb Mon Sep 17 00:00:00 2001 From: Anirudh Gupta <146579014+AnirudhG07@users.noreply.github.com> Date: Sat, 17 Aug 2024 00:50:03 +0530 Subject: [PATCH 02/10] docs: cursor added to shell commands --- docs/configuration/keymap.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/configuration/keymap.md b/docs/configuration/keymap.md index f9668c80..d966bfc1 100644 --- a/docs/configuration/keymap.md +++ b/docs/configuration/keymap.md @@ -324,6 +324,7 @@ Run a shell command. | `--orphan` | Keep the process running even if Yazi has exited, once specified, the process will be detached from the task scheduling system. | | `--confirm` | When the template is provided, run it directly, no input UI was shown. It's mutually exclusive with `--interactive`. | | `--interactive` | Request the user to input the command to be executed interactively. It's mutually exclusive with `--confirm`. | +| `--cursor` | Allows user to define keymaps with cursor set to generic place like `--cursor=`. Use `` to specify the place, in integer. Default is set to end. You can use the following shell variables in `[run]`: From baef45ce8bb910c2c15cc51c154e98d719b53abe Mon Sep 17 00:00:00 2001 From: Anirudh Gupta <146579014+AnirudhG07@users.noreply.github.com> Date: Sat, 17 Aug 2024 01:03:31 +0530 Subject: [PATCH 03/10] docs: status in Command --- docs/plugins/utils.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/plugins/utils.md b/docs/plugins/utils.md index a37d4dfc..a6d6dd13 100644 --- a/docs/plugins/utils.md +++ b/docs/plugins/utils.md @@ -585,6 +585,17 @@ Spawn the command and wait for it to finish, returns `(output, err)`: - `output` - The [Output](#output) of the command if successful; otherwise, `nil` - `err` - The error code if the operation is failed, which is an integer if any +### `status()` {#Command.status} + +```lua +local status, err = Command("ls"):status() +``` + +Retrieves the current status of the child process, returns `(status, err)`: + +- `status` - The Status object representing the child process status, or nil if an error occurred. +- `err` - The error code if fetching the status fails, otherwise nil. + ## Child This object is created by [`Command:spawn()`](#Command.spawn) and represents a running child process. From 6afada4055d766cec1bbcc9f84b7005a022a335b Mon Sep 17 00:00:00 2001 From: Anirudh Gupta <146579014+AnirudhG07@users.noreply.github.com> Date: Sat, 17 Aug 2024 01:15:41 +0530 Subject: [PATCH 04/10] docs: ya.md5 in hash --- docs/plugins/utils.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/plugins/utils.md b/docs/plugins/utils.md index a6d6dd13..d36b7278 100644 --- a/docs/plugins/utils.md +++ b/docs/plugins/utils.md @@ -341,6 +341,16 @@ ya.clipboard("new content") This function is only available in the async context. +### `md5(str)` {#ya.md5} + +Calculates the MD5 hash of the given string. + +- `str` - Required, the string to be hashed. + +```lua +local hash = ya.md5(str) +``` + ## ps {#ps} Yazi's DDS (Data Distribution Service) uses a Lua-based publish-subscribe model as its carrier. That is, you can achieve cross-instance communication and state persistence through the `ps` API. See [DDS](/docs/dds) for details. From 2263d4a27fbcd5923f8eba796d36df4c540439a0 Mon Sep 17 00:00:00 2001 From: Anirudh Gupta <146579014+AnirudhG07@users.noreply.github.com> Date: Sat, 17 Aug 2024 01:24:42 +0530 Subject: [PATCH 05/10] docs: added fs.remove and read_dir --- docs/plugins/utils.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/plugins/utils.md b/docs/plugins/utils.md index d36b7278..7e826dfc 100644 --- a/docs/plugins/utils.md +++ b/docs/plugins/utils.md @@ -448,6 +448,42 @@ Returns `(ok, err)`: - `ok` - Whether the operation is successful, which is a boolean - `err` - The error code if the operation is failed, which is an integer if any +### `remove(type, url)` {#fs.remove} + +```lua +local ok, err = fs.remove("file", "url") +``` + +Removes a file or directory: + +- `type` - Required, the type of removal, which can be "file", "dir", "dir_all", or "dir_clean". +- `url` - Required, the [Url](/docs/plugins/types#shared.url) of the file or directory. + +Returns `(ok, err)`: + +- `ok` - Whether the operation is successful, which is a boolean +- `err` - The error code if the operation is failed, which is an integer if any + +### `read_dir(url, options)` {#fs.read_dir} + +```lua +local files, err = fs.read_dir("url", { limit = 10 }) +``` + +Reads the contents of a directory: + +- `url` - Required, the [Url](/docs/plugins/types#shared.url) of the directory +- `options` - Optional, a table with the following options: + - `limit` - The maximum number of files to return, defaults to `math.maxint` + - `resolve` - Whether to resolve symbolic links, defaults to `false` + - `glob` - A glob pattern to filter files + +Returns `(files, err)`: + +- `files` - A table of [File](/docs/plugins/types#shared.file) objects if successful; otherwise, `nil` +- `err` - The error code if the operation is failed, which is an integer if any + + ### `cha(url, follow)` {#fs.cha} ```lua From 041d7a6f39f13a0455c7115367929d73fe73028f Mon Sep 17 00:00:00 2001 From: AnirudhG07 Date: Wed, 21 Aug 2024 17:27:13 +0530 Subject: [PATCH 06/10] docs: ya pack in dds --- docs/dds.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/dds.md b/docs/dds.md index 51ebb10d..eb0cfa17 100644 --- a/docs/dds.md +++ b/docs/dds.md @@ -66,6 +66,50 @@ For greater convenience in integrating within the command-line environment, they Note that `ya` is a standalone CLI program introduced since Yazi 0.2.5, it might conflict with the shell wrapper you setup before, see [Introduce a standalone CLI program](https://github.com/sxyazi/yazi/issues/914) for details. +### Yazi Package manager {#yazi-package-manager} + +Yazi command line tool also provides a package manager for Yazi plugins, flavors and other packages. You can download and add a package using `ya pack`. For example, to install a plugin with author `author_name` and plugin name `plugin.yazi`, you can run: + +```sh +ya pack -a author_name/plugin +``` + +This downloads the plugin in your `$YAZI_CONFIG_HOME` directory(default is `~/.config/yazi`). The package information is stored in `package.toml` file containing the latest commit of plugin, author and plugin name in the format: + +```toml +[plugin] + +deps = [{ + use = "author_name/plugin", + rev = "abcd12", +}] +``` + +Similarly, flavours can be installed using `ya pack -f author_name/flavour` which will be stored in the format: + +```toml +[flavour] + +deps = [{ + use = "author_name/flavour", + rev = "abcd12", +}] +``` + +To list all the plugins managed by `ya pack`, you can run: + +```sh +ya pack {-l|--list} +``` + +`ya pack` allows you to upgrade all packages at once using: + +```sh +ya pack {-u|--upgrade} +``` + +This will also update the `package.toml` file with the latest commit of the plugin. For more information on `ya pack`, you check `ya pack --help` + ### Real-time `stdout` reporting {#stdout-reporting} You can specify the `--local-events` and `--remote-events` options when starting Yazi: From 659c429aed727398966f07f7490a19bd46d78f0d Mon Sep 17 00:00:00 2001 From: Anirudh Gupta <146579014+AnirudhG07@users.noreply.github.com> Date: Sun, 25 Aug 2024 02:13:11 +0530 Subject: [PATCH 07/10] docs: utils ya.preview_code update --- docs/plugins/utils.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/plugins/utils.md b/docs/plugins/utils.md index 7e826dfc..7de08880 100644 --- a/docs/plugins/utils.md +++ b/docs/plugins/utils.md @@ -205,10 +205,10 @@ Preview the file as code into the specified area: - `skip` - The number of units to skip. It's units largely depend on your previewer, such as lines for code, and percentages for videos - `window` - The [Window](/docs/plugins/types#shared.window) of the preview -Returns `(ok, upper_bound)`: +Returns `(err, upper_bound)`: -- `ok` - Whether the preview is successful, which is a boolean. -- `upper_bound` - If the preview fails (`ok = false`) and it's because exceeds the maximum upper bound, return this bound; otherwise, `nil`. +- `err` - Whether the preview is successful, which is a string. +- `upper_bound` - If the preview fails (`err = true`) and it's because exceeds the maximum upper bound, return this bound; otherwise, `nil`. This function is only available in the async context. From f7d56513979cb7a39d06b5c667a309d8763bd023 Mon Sep 17 00:00:00 2001 From: AnirudhG07 Date: Mon, 26 Aug 2024 13:11:38 +0530 Subject: [PATCH 08/10] docs: add wrap in yazi.toml preview --- docs/configuration/yazi.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/configuration/yazi.md b/docs/configuration/yazi.md index e9b1d05d..41d27c1a 100644 --- a/docs/configuration/yazi.md +++ b/docs/configuration/yazi.md @@ -192,6 +192,15 @@ This is useful for solving [a bug of รœberzug++ image size calculation](https:// If your monitor has a `2.0` scale factor, and is running on Wayland under Hyprland, you may need to set `ueberzug_scale: 0.5`, and adjust the value of `ueberzug_offset` according to your case, to offset this issue. +### `wrap` {#preview.wrap} + +Wrap long lines in the preview for `code` preview. + +- `"yes"`: Enable wrapping in preview. +- `"no"`: Disable wrapping in preview. + +Default is set to `"no"`. + ## [opener] {#opener} Configure available openers that can be used in [`[open]`](#open), for example: From 3677d0a426954e9a9a452bd4d3bf3f60f23e0ff1 Mon Sep 17 00:00:00 2001 From: AnirudhG07 Date: Tue, 27 Aug 2024 01:42:07 +0530 Subject: [PATCH 09/10] docs: fix in upper_bound err comp --- docs/plugins/utils.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/plugins/utils.md b/docs/plugins/utils.md index 7de08880..73a72b02 100644 --- a/docs/plugins/utils.md +++ b/docs/plugins/utils.md @@ -208,7 +208,7 @@ Preview the file as code into the specified area: Returns `(err, upper_bound)`: - `err` - Whether the preview is successful, which is a string. -- `upper_bound` - If the preview fails (`err = true`) and it's because exceeds the maximum upper bound, return this bound; otherwise, `nil`. +- `upper_bound` - If the preview fails and it's because exceeds the maximum upper bound, return this bound; otherwise, `nil`. This function is only available in the async context. @@ -483,7 +483,6 @@ Returns `(files, err)`: - `files` - A table of [File](/docs/plugins/types#shared.file) objects if successful; otherwise, `nil` - `err` - The error code if the operation is failed, which is an integer if any - ### `cha(url, follow)` {#fs.cha} ```lua From dff7511fe4e6ea18f2f50dba499f6d60809f5cbf Mon Sep 17 00:00:00 2001 From: sxyazi Date: Sat, 7 Sep 2024 16:15:04 +0800 Subject: [PATCH 10/10] Reword --- docs/cli.md | 63 ++++++++++++++++++++++++++++++++++ docs/configuration/keymap.md | 8 ++--- docs/configuration/yazi.md | 4 +-- docs/dds.md | 44 ------------------------ docs/faq.md | 2 +- docs/plugins/utils.md | 65 ++++++++++++++++-------------------- docs/resources.md | 4 +-- docs/tips.md | 2 +- 8 files changed, 100 insertions(+), 92 deletions(-) create mode 100644 docs/cli.md diff --git a/docs/cli.md b/docs/cli.md new file mode 100644 index 00000000..5bfa5d7e --- /dev/null +++ b/docs/cli.md @@ -0,0 +1,63 @@ +--- +sidebar_position: 8 +description: Data Distribution Service +--- + +# CLI + +Yazi provides a command-line tool called `ya`, which is used to assist with tasks like plugin management, flavor management, DDS message publishing and subscribing, among other features. + +It is an essential component of Yazi. Most distributions include it by default when installing Yazi, but if yours doesn't, you'll need to build it from source. Just be sure that the versions of both `ya` and `yazi` are exactly the same. + +## Package Manager + +You can manage your plugins and flavors using the `ya pack` subcommand. For example, to install the plugin from https://github.com/owner/my-plugin.yazi, run: + +```sh +ya pack -a owner/my-plugin +``` + +`ya pack` also supports installing a subdirectory from a monorepo as a package. For example, to install the package from https://github.com/yazi-rs/plugins/tree/main/git.yazi, run: + +```sh +ya pack -a yazi-rs/plugins:git +``` + +and it will automatically clone them from GitHub, copy them to your plugins directory, and update the `package.toml` to lock their versions: + +```toml +# ~/.config/yazi/package.toml +[plugin] +deps = [ + { use = "owner/my-plugin", rev = "0573024" }, + { use = "yazi-rs/plugins:git", rev = "9a1129c" } +] +``` + +To list all the plugins managed by `ya pack`: + +```sh +ya pack -l +``` + +To install all the plugins with locked versions from `package.toml` on a new system: + +```sh +ya pack -i +``` + +To upgrade all the plugins to the latest version: + +```sh +ya pack -u +``` + +If you want to pin a plugin to a specific version so that it doesn't get upgraded when running `ya pack -u`, add an `=` qualifier before the hash in `rev`: + +```diff +[plugin] +deps = [ +- { use = "owner/my-plugin", rev = "9a1129c" } ++ { use = "owner/my-plugin", rev = "=9a1129c" } +] +``` diff --git a/docs/configuration/keymap.md b/docs/configuration/keymap.md index d966bfc1..0b485e3d 100644 --- a/docs/configuration/keymap.md +++ b/docs/configuration/keymap.md @@ -319,12 +319,12 @@ Run a shell command. | Argument/Option | Description | | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `[run]` | Optional, command template to be run. | +| `[template]` | Optional, command template to be run. | | `--block` | Open in a blocking manner. After setting this, Yazi will hide into a secondary screen and display the program on the main screen until it exits. During this time, it can receive I/O signals, which is useful for interactive programs. | | `--orphan` | Keep the process running even if Yazi has exited, once specified, the process will be detached from the task scheduling system. | -| `--confirm` | When the template is provided, run it directly, no input UI was shown. It's mutually exclusive with `--interactive`. | -| `--interactive` | Request the user to input the command to be executed interactively. It's mutually exclusive with `--confirm`. | -| `--cursor` | Allows user to define keymaps with cursor set to generic place like `--cursor=`. Use `` to specify the place, in integer. Default is set to end. +| `--confirm` | When the template is provided, run it directly, no input box was shown. It's mutually exclusive with `--interactive`. | +| `--interactive` | Request the user to input the command to be ran interactively. It's mutually exclusive with `--confirm`. | +| `--cursor` | Set the initial position of the cursor in the interactive command input box. For example, `shell 'zip -r .zip "$0"' --cursor=7 --interactive` places the cursor before `.zip`. | You can use the following shell variables in `[run]`: diff --git a/docs/configuration/yazi.md b/docs/configuration/yazi.md index 41d27c1a..04902e96 100644 --- a/docs/configuration/yazi.md +++ b/docs/configuration/yazi.md @@ -194,13 +194,11 @@ If your monitor has a `2.0` scale factor, and is running on Wayland under Hyprla ### `wrap` {#preview.wrap} -Wrap long lines in the preview for `code` preview. +Wrap long lines in the preview for code preview. - `"yes"`: Enable wrapping in preview. - `"no"`: Disable wrapping in preview. -Default is set to `"no"`. - ## [opener] {#opener} Configure available openers that can be used in [`[open]`](#open), for example: diff --git a/docs/dds.md b/docs/dds.md index eb0cfa17..51ebb10d 100644 --- a/docs/dds.md +++ b/docs/dds.md @@ -66,50 +66,6 @@ For greater convenience in integrating within the command-line environment, they Note that `ya` is a standalone CLI program introduced since Yazi 0.2.5, it might conflict with the shell wrapper you setup before, see [Introduce a standalone CLI program](https://github.com/sxyazi/yazi/issues/914) for details. -### Yazi Package manager {#yazi-package-manager} - -Yazi command line tool also provides a package manager for Yazi plugins, flavors and other packages. You can download and add a package using `ya pack`. For example, to install a plugin with author `author_name` and plugin name `plugin.yazi`, you can run: - -```sh -ya pack -a author_name/plugin -``` - -This downloads the plugin in your `$YAZI_CONFIG_HOME` directory(default is `~/.config/yazi`). The package information is stored in `package.toml` file containing the latest commit of plugin, author and plugin name in the format: - -```toml -[plugin] - -deps = [{ - use = "author_name/plugin", - rev = "abcd12", -}] -``` - -Similarly, flavours can be installed using `ya pack -f author_name/flavour` which will be stored in the format: - -```toml -[flavour] - -deps = [{ - use = "author_name/flavour", - rev = "abcd12", -}] -``` - -To list all the plugins managed by `ya pack`, you can run: - -```sh -ya pack {-l|--list} -``` - -`ya pack` allows you to upgrade all packages at once using: - -```sh -ya pack {-u|--upgrade} -``` - -This will also update the `package.toml` file with the latest commit of the plugin. For more information on `ya pack`, you check `ya pack --help` - ### Real-time `stdout` reporting {#stdout-reporting} You can specify the `--local-events` and `--remote-events` options when starting Yazi: diff --git a/docs/faq.md b/docs/faq.md index a89bfdfa..6147a146 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 11 description: Answers to some frequently asked questions about Yazi. --- diff --git a/docs/plugins/utils.md b/docs/plugins/utils.md index 73a72b02..fe595a9d 100644 --- a/docs/plugins/utils.md +++ b/docs/plugins/utils.md @@ -207,24 +207,11 @@ Preview the file as code into the specified area: Returns `(err, upper_bound)`: -- `err` - Whether the preview is successful, which is a string. +- `err` - Error string if the preview fails; otherwise, `nil`. - `upper_bound` - If the preview fails and it's because exceeds the maximum upper bound, return this bound; otherwise, `nil`. This function is only available in the async context. -### `preview_archive(opts)` {#ya.preview_archive} - -Preview the file as an archive into the specified area: - -- `opts` - Required, the options of the preview. It's the same as [`preview_code()`](#ya.preview_code) - -Returns `(ok, upper_bound)`: - -- `ok` - Whether the preview is successful, which is a boolean. -- `upper_bound` - If the preview fails (`ok = false`) and it's because exceeds the maximum upper bound, return this bound; otherwise, `nil`. - -This function is only available in the async context. - ### `preview_widgets(opts, widgets)` {#ya.preview_widgets} - `opts` - Required, the options of the preview, which is a table: @@ -281,6 +268,16 @@ Truncate the text to the specified length and return it: Returns the current timestamp, which is a float, the integer part represents the seconds, and the decimal part represents the milliseconds. +### `md5(str)` {#ya.md5} + +Calculates the MD5 of the given string. + +- `str` - Required, the string to be hashed. + +```lua +local hash = ya.md5("Hello, World!") +``` + ### `sleep(secs)` {#ya.sleep} Waits until `secs` has elapsed: @@ -341,16 +338,6 @@ ya.clipboard("new content") This function is only available in the async context. -### `md5(str)` {#ya.md5} - -Calculates the MD5 hash of the given string. - -- `str` - Required, the string to be hashed. - -```lua -local hash = ya.md5(str) -``` - ## ps {#ps} Yazi's DDS (Data Distribution Service) uses a Lua-based publish-subscribe model as its carrier. That is, you can achieve cross-instance communication and state persistence through the `ps` API. See [DDS](/docs/dds) for details. @@ -451,13 +438,17 @@ Returns `(ok, err)`: ### `remove(type, url)` {#fs.remove} ```lua -local ok, err = fs.remove("file", "url") +local ok, err = fs.remove("file", Url("/tmp/test.txt")) ``` -Removes a file or directory: +Remove the specified file(s) from the filesystem: -- `type` - Required, the type of removal, which can be "file", "dir", "dir_all", or "dir_clean". -- `url` - Required, the [Url](/docs/plugins/types#shared.url) of the file or directory. +- `type` - Required, the type of removal, which can be: + - `"file"` - Removes a file from the filesystem. + - `"dir"` - Removes an existing, empty directory. + - `"dir_all"` - Removes a directory at this url, after removing all its contents. Use carefully! + - `"dir_clean"` - Remove all empty directories under it, and if the directory itself is empty afterward, remove it as well. +- `url` - Required, the [Url](/docs/plugins/types#shared.url) of the target. Returns `(ok, err)`: @@ -472,16 +463,16 @@ local files, err = fs.read_dir("url", { limit = 10 }) Reads the contents of a directory: -- `url` - Required, the [Url](/docs/plugins/types#shared.url) of the directory +- `url` - Required, the [Url](/docs/plugins/types#shared.url) of the directory. - `options` - Optional, a table with the following options: - - `limit` - The maximum number of files to return, defaults to `math.maxint` - - `resolve` - Whether to resolve symbolic links, defaults to `false` - - `glob` - A glob pattern to filter files + - `glob` - A glob pattern to filter files out if provided. + - `limit` - The maximum number of files to read, which is an integer, defaults to unlimited. + - `resolve` - Whether to resolve symbolic links, defaults to `false`. Returns `(files, err)`: -- `files` - A table of [File](/docs/plugins/types#shared.file) objects if successful; otherwise, `nil` -- `err` - The error code if the operation is failed, which is an integer if any +- `files` - A table of [File](/docs/plugins/types#shared.file) if successful; otherwise, `nil`. +- `err` - The error code if the operation is failed, which is an integer if any. ### `cha(url, follow)` {#fs.cha} @@ -636,10 +627,10 @@ Spawn the command and wait for it to finish, returns `(output, err)`: local status, err = Command("ls"):status() ``` -Retrieves the current status of the child process, returns `(status, err)`: +Executes the command as a child process, waiting for it to finish and collecting its exit status. Returns `(status, err)`: -- `status` - The Status object representing the child process status, or nil if an error occurred. -- `err` - The error code if fetching the status fails, otherwise nil. +- `status` - The [Status](#status) of the child process if successful; otherwise, `nil` +- `err` - The error code if the operation is failed, which is an integer if any ## Child diff --git a/docs/resources.md b/docs/resources.md index 282cb527..2bd3922b 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 10 description: Some awesome plugins for Yazi. --- @@ -141,7 +141,7 @@ Vim: ## ๐Ÿš Shell plugins {#shell} - [yazi-prompt.sh](https://github.com/Sonico98/yazi-prompt.sh) - Display an indicator in your prompt when running inside a yazi subshell. -- [custom-shell.yazi](https://github.com/AnirudhG07/custom-shell.yazi) - Set your custom-shell as your default yazi Shell and run any custom command through any shell. +- [custom-shell.yazi](https://github.com/AnirudhG07/custom-shell.yazi) - Run any commands through your default system shell. - [command.yazi](https://github.com/KKV9/command.yazi) - Display a prompt for executing yazi commands. ## ๐Ÿ› ๏ธ Utilities {#utilities} diff --git a/docs/tips.md b/docs/tips.md index fd1625de..6b8362d4 100644 --- a/docs/tips.md +++ b/docs/tips.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 9 description: A few helpful tips for using Yazi. ---