Skip to content

Commit e49bfef

Browse files
committed
docs(readme): add mise usage instructions with alias configuration
1 parent eb66835 commit e49bfef

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,56 @@ etcd [vfox](https://github.com/version-fox) plugin. Use the vfox to manage multi
1212

1313
## Usage
1414

15+
### vfox
16+
1517
```shell
1618
# install plugin
1719
vfox add --source https://github.com/version-fox/vfox-etcd/archive/refs/heads/main.zip etcd
1820

1921
# install an available etcd version
20-
vofx search etcd
22+
vfox search etcd
2123
# or specific version
2224
vfox install etcd@3.5.5
2325
```
2426

27+
### mise
28+
29+
[vfox](https://github.com/version-fox/vfox) is the recommended plugin system for [mise](https://mise.jdx.dev/). You can use this plugin directly with mise via the `vfox:` prefix.
30+
31+
```shell
32+
# install etcd & set as global version
33+
mise use -g vfox:version-fox/vfox-etcd@latest
34+
35+
# or install a specific version
36+
mise use -g vfox:version-fox/vfox-etcd@3.5.5
37+
38+
# install for local project (creates .mise.toml)
39+
mise use vfox:version-fox/vfox-etcd@3.5.5
40+
```
41+
42+
This sets the version in `~/.config/mise/config.toml`:
43+
44+
```toml
45+
[tools]
46+
"vfox:version-fox/vfox-etcd" = "latest"
47+
```
48+
49+
#### Simplify with alias
50+
51+
Add an alias to your `~/.config/mise/config.toml` to use `etcd` as the short name:
52+
53+
```toml
54+
[alias]
55+
etcd = "vfox:version-fox/vfox-etcd"
56+
```
57+
58+
After that, you can use the simplified syntax:
59+
60+
```shell
61+
mise use -g etcd@latest
62+
mise install etcd@3.5.5
63+
```
64+
2565
### etcd with failpoint (Only support in Unix-like OS system)
2666

2767
For the [chaos testing](https://testsigma.com/blog/chaos-testing/) proposal, you can also utilize vfox-etcd to build etcd with failpoint. Example:

0 commit comments

Comments
 (0)