summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRashil Gandhi <46838874+rashil2000@users.noreply.github.com>2022-01-10 11:17:53 +0530
committerGitHub <noreply@github.com>2022-01-09 23:47:53 -0600
commitc335b4267b80d584ed8a5d0dc7cfe7bf0bf7a74b (patch)
tree369b039128aae86085caffd228675d92817ca744 /README.md
parent20a78c1153550cd507f29f8af3138ce6333bcf06 (diff)
feat: add support for cmd (#3277)
* feat: add support for cmd * add preprompt and precmd support * add keymap support * add info about minimum Clink version * simplify escaping * add handling for cmd custom commands * add support for transient_prompt and transient_rprompt * Revert 914057952508e81e20086fcb707ba2a0be85fdd3 This reverts commit "add support for transient_prompt and transient_rprompt" * Apply suggestions from code review * disable cmd shell custom commands * any shell other than cmd can be used * better error and correct script location * move shell check in `map_no_escaping`
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index c728feccc..1cbfa09e2 100644
--- a/README.md
+++ b/README.md
@@ -287,6 +287,16 @@ shown below. Can't see yours? Have a look at the [extra platform instructions](h
execx($(starship init xonsh))
```
+ #### Cmd
+
+ You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
+
+ ```lua
+ -- starship.lua
+
+ load(io.popen('starship init cmd'):read("*a"))()
+ ```
+
#### Nushell
**Warning** This will change in the future. Only nu version v0.33 or higher is supported.