diff --git a/go/README.md b/go/README.md index 286005a97..b4db65200 100644 --- a/go/README.md +++ b/go/README.md @@ -143,8 +143,12 @@ argv.UsageLine([]string{"mise"}, mise.Root, mise.HelpText) `Arguments`, `Flags` and `Global flags`, with the columns lined up and the inherited globals worked out the way the parser resolves them. -**All 211 of mise's usage lines and all 211 of its pages match usage-lib's byte -for byte**, which is the test that keeps both honest. usage-lib builds the line from a spec through a +`argv.LongHelp` renders `--help`: the same content through a wider layout, with +help wrapped into a column, the long form of each description preferred, and each +annotation on its own line. + +**All 211 usage lines, all 211 `-h` pages and all 211 `--help` pages match +usage-lib byte for byte**, which is the test that keeps them honest. usage-lib builds the line from a spec through a template over a runtime model; this builds it from static tables. Reimplemented rules drift, so both are run over mise's real spec and compared — the same check `benches/gate/tests/help.rs` makes for usage-argv, against the same reference. @@ -187,9 +191,6 @@ claim is measured at real scale rather than against a fixture with four flags: - **Typed values.** Binding collects text. Something still has to turn `"8"` into an `int` and `"1m"` into a `time.Duration`, and report the ones that will not convert. -- **The long page.** `-h` is done; `--help` wraps long descriptions and switches - to a two-line layout for entries that have a longer form, which `ShortHelp` - does not do. - **Errors worth reading.** `Error()` returns `unknown flag: --wat`, which names the problem and helps nobody fix it. usage-argv renders these through miette with the offending token underlined. diff --git a/go/argv/help.go b/go/argv/help.go index 8b3729280..e322cefcf 100644 --- a/go/argv/help.go +++ b/go/argv/help.go @@ -66,9 +66,11 @@ type Help struct { Env string Default []string // BeforeHelp and AfterHelp bracket this command's page, overriding the - // spec-wide text. - BeforeHelp string - AfterHelp string + // spec-wide text. The long variants are preferred by `--help`. + BeforeHelp string + AfterHelp string + BeforeLongHelp string + AfterLongHelp string // Examples are worked invocations, printed last. Examples []Example } diff --git a/go/argv/page.go b/go/argv/page.go index 66560703f..bbd09d42a 100644 --- a/go/argv/page.go +++ b/go/argv/page.go @@ -3,6 +3,7 @@ package argv import ( "sort" "strings" + "unicode" ) // The page `-h` prints. @@ -26,15 +27,23 @@ type HelpSpec struct { // About is the root's description, which the root's page uses in place of the // command's own. About string - // BeforeHelp and AfterHelp bracket every page that does not override them. - BeforeHelp string - AfterHelp string + // LongAbout is what `--help` prefers over About. + LongAbout string + // BeforeHelp and AfterHelp bracket every page that does not override them, + // and the long variants are what `--help` prefers. + BeforeHelp string + AfterHelp string + BeforeLongHelp string + AfterLongHelp string } // Example is one worked invocation, as a page prints it. type Example struct { Header string Code string + // Help introduces the line on the long page, printed above the command + // rather than beside it. + Help string } // shortCol is the width the short-flag column is padded to, so that `-J, --json` @@ -80,7 +89,10 @@ func ShortHelp(spec HelpSpec, path []string, chain []*Command, help HelpTable) s } else if meta != nil { about = meta.Short } - if about != "" { + // Trimmed as the long page trims it, and for the same reason: the blank line + // under a description belongs to the renderer, so one already in the text is a + // second one. + if about := trimEnd(about); about != "" { out.WriteString(about + "\n\n") } @@ -161,7 +173,7 @@ func ShortHelp(spec HelpSpec, path []string, chain []*Command, help HelpTable) s func(int) string { return "" }, func(w *strings.Builder, i int) { entry(w, inherited[i]) }) - examplesSection(&out, meta) + examplesSection(&out, pageExamples(chain, help, meta)) after := spec.AfterHelp if meta != nil && meta.AfterHelp != "" { @@ -201,7 +213,7 @@ func commandsSection(out *strings.Builder, path []string, cmd *Command, help Hel out.WriteString("\nCommands:\n") // Sorted by the rendered usage rather than by name, as usage-lib sorts them. - sort.SliceStable(lines, func(i, j int) bool { return lines[i].usage < lines[j].usage }) + sortLines(lines, func(i int) string { return lines[i].usage }) for _, l := range lines { out.WriteString(" " + l.usage) @@ -256,12 +268,30 @@ func groupsSection(out *strings.Builder, defaultTitle string, n int, } } -func examplesSection(out *strings.Builder, meta *Help) { - if meta == nil || len(meta.Examples) == 0 { +// pageExamples is a command's own examples, or the root's where it has none. +// +// The same fallback `BeforeHelp` and `AfterHelp` get, and for the same reason: a +// CLI writing examples once at the top means them to appear. mise declares none +// at its root, so the 211-page parity test cannot see this either way — it is +// checked against the reference's rule rather than against the fixture. +func pageExamples(chain []*Command, help HelpTable, meta *Help) []Example { + if meta != nil && len(meta.Examples) > 0 { + return meta.Examples + } + if len(chain) > 0 { + if root := help.Lookup(chain[0].Key); root != nil { + return root.Examples + } + } + return nil +} + +func examplesSection(out *strings.Builder, examples []Example) { + if len(examples) == 0 { return } out.WriteString("\nExamples:\n") - for _, e := range meta.Examples { + for _, e := range examples { if e.Header != "" { out.WriteString(" " + e.Header + ":\n") } @@ -325,6 +355,17 @@ func pad(s string, col int) string { func width(s string) int { return len([]rune(s)) } +// trimEnd drops trailing whitespace, which is what `str::trim_end` does on the +// two sides this is ported from. +func trimEnd(s string) string { return strings.TrimRightFunc(s, unicode.IsSpace) } + +// sortLines orders a section's entries by their rendered usage, which is how +// usage-lib orders them — for a command with no flags or arguments that agrees +// with sorting by name, and where it differs this is what a reader sees. +func sortLines[T any](lines []T, key func(int) string) { + sort.SliceStable(lines, func(i, j int) bool { return key(i) < key(j) }) +} + func min(a, b int) int { if a < b { return a diff --git a/go/argv/page_long.go b/go/argv/page_long.go new file mode 100644 index 000000000..3f594b607 --- /dev/null +++ b/go/argv/page_long.go @@ -0,0 +1,300 @@ +package argv + +import "strings" + +// The page `--help` prints. +// +// The same content as [ShortHelp] through a wider layout: help is aligned into a +// column and wrapped, the long form of each description is preferred over the +// short one, and the annotations each get their own line. +// +// An entry whose help contains a line break is laid out as a block instead, its +// text indented under the usage rather than beside it — there is no column that +// keeps a line the author already broke readable. + +// helpWidth is the width the long page wraps to. usage-lib reads the terminal and +// falls back to 80; a page rendered into a test, a file or a pipe has no terminal, +// so 80 is what both sides use and what keeps the two comparable. +const helpWidth = 80 + +// LongHelp renders what `--help` prints for the command at the end of `chain`. +func LongHelp(spec HelpSpec, path []string, chain []*Command, help HelpTable) string { + if len(chain) == 0 { + return "" + } + cmd := chain[len(chain)-1] + meta := help.Lookup(cmd.Key) + var out strings.Builder + + before := firstOf(metaField(meta, func(h *Help) string { return h.BeforeLongHelp }), + metaField(meta, func(h *Help) string { return h.BeforeHelp }), + spec.BeforeLongHelp, spec.BeforeHelp) + if before != "" { + out.WriteString(before + "\n\n") + } + + // The banner and the program's own description belong to the program's page. + // A subcommand's page describes the subcommand, which is the question that + // was asked. + root := len(path) <= 1 + if root && spec.Version != "" { + name := spec.Name + if name == "" { + name = spec.Bin + } + out.WriteString(name + " " + spec.Version + "\n") + } + about := "" + if root { + about = firstOf(spec.LongAbout, spec.About) + } else if meta != nil { + about = firstOf(meta.Long, meta.Short) + } + // Trimmed for the same reason the entries below are: the blank line after the + // description is written here, so one already in the text doubles it. clap's + // `long_about` often ends in a break — a `///` block whose last line is empty, + // an examples section written with a trailing newline — and it reaches the spec + // verbatim. + if about := trimEnd(about); about != "" { + out.WriteString(about + "\n\n") + } + + out.WriteString("Usage: " + UsageLine(path, cmd, help) + "\n") + + longCommandsSection(&out, path[min(1, len(path)):], cmd, help) + + // One column width per section, over its visible entries — separately, so a + // long flag does not push the arguments out. + args := visibleArgs(cmd, help) + argCol := 0 + for _, a := range args { + if n := width(argUsage(a, help.Lookup(a.Key))); n > argCol { + argCol = n + } + } + groupsSection(&out, "Arguments", len(args), + func(i int) string { return headingOf(help, args[i].Key) }, + func(w *strings.Builder, i int) { + h := help.Lookup(args[i].Key) + entry(w, argUsage(args[i], h), firstOf(metaField(h, func(x *Help) string { return x.Long }), + metaField(h, func(x *Help) string { return x.Short })), argCol) + longAnnotations(w, h, true) + }) + + own, inherited := ownAndGlobal(chain, help) + + // One column over *both* lists, so the two sections read as one table with a + // rule through it rather than two tables that happen to be adjacent. + flagCol := 0 + for _, f := range append(append([]shownFlag{}, own...), inherited...) { + if n := width(f.usage); n > flagCol { + flagCol = n + } + } + writeFlag := func(w *strings.Builder, f shownFlag) { + if f.supplied != "" { + entry(w, f.usage, f.suppliedHelp, flagCol) + return + } + h := help.Lookup(f.key) + entry(w, f.usage, firstOf(metaField(h, func(x *Help) string { return x.Long }), + metaField(h, func(x *Help) string { return x.Short })), flagCol) + longAnnotations(w, h, false) + } + groupsSection(&out, "Flags", len(own), + func(i int) string { + if own[i].supplied != "" { + return "" + } + return headingOf(help, own[i].key) + }, + func(w *strings.Builder, i int) { writeFlag(w, own[i]) }) + // Not grouped by heading: an ancestor's headings describe that command's page, + // and borrowing them here would put a section title on flags that are only + // visiting. + groupsSection(&out, "Global flags", len(inherited), + func(int) string { return "" }, + func(w *strings.Builder, i int) { writeFlag(w, inherited[i]) }) + + if examples := pageExamples(chain, help, meta); len(examples) > 0 { + out.WriteString("\nExamples:\n") + for _, e := range examples { + if e.Header != "" { + out.WriteString(" " + e.Header + ":\n") + } + // The description comes *before* the command, which is the order the + // reference prints them in: it introduces the line rather than + // commenting on it. + if e.Help != "" { + out.WriteString(" " + e.Help + "\n") + } + out.WriteString(" $ " + e.Code + "\n") + } + } + + after := firstOf(metaField(meta, func(h *Help) string { return h.AfterLongHelp }), + metaField(meta, func(h *Help) string { return h.AfterHelp }), + spec.AfterLongHelp, spec.AfterHelp) + if after != "" { + out.WriteString("\n" + after + "\n") + } + + return strings.TrimSpace(out.String()) + "\n" +} + +// longCommandsSection lists the subcommands, each description on its own indented +// line rather than beside the name. +func longCommandsSection(out *strings.Builder, path []string, cmd *Command, help HelpTable) { + type line struct { + usage string + sub *Command + } + var lines []line + for _, sub := range cmd.Subcommands { + if h := help.Lookup(sub.Key); h != nil && h.Hide { + continue + } + subPath := append(append([]string{}, path...), sub.Name) + lines = append(lines, line{UsageLine(subPath, sub, help), sub}) + } + if len(lines) == 0 { + return + } + out.WriteString("\nCommands:\n") + sortLines(lines, func(i int) string { return lines[i].usage }) + + for _, l := range lines { + out.WriteString(" " + l.usage) + h := help.Lookup(l.sub.Key) + if h != nil && len(h.VisibleAliases) > 0 { + out.WriteString(" [aliases: " + strings.Join(h.VisibleAliases, ", ") + "]") + } + out.WriteString("\n") + if h != nil { + // Trailing whitespace trimmed: the blank line after each entry is + // written below, and a description that happens to end in a newline + // added a second one — a stray blank in the middle of the list. + if about := trimEnd(firstOf(h.Long, h.Short)); about != "" { + writeIndented(out, about, 4) + } + } + // A blank line between entries, which the wider layout can afford and + // which keeps a multi-line description from running into the next name. + out.WriteString("\n") + } + out.WriteString(" help\n Print this message or the help of the given subcommand(s)\n") +} + +// entry writes one flag or argument: its help in a column beside it, wrapped — or +// indented underneath, where the text has line breaks of its own. +func entry(out *strings.Builder, usage, help string, col int) { + if strings.TrimSpace(help) == "" { + out.WriteString(" " + usage + "\n") + return + } + + // The column layout only works for text that has not been broken already, and + // only when there is room left for it to say anything. + indent := 2 + col + 2 + room := helpWidth - indent + if room < 0 { + room = 0 + } + if strings.Contains(help, "\n") || room < 10 { + out.WriteString(" " + usage + "\n") + writeIndented(out, help, 4) + return + } + + lines := wrap(help, room) + out.WriteString(" " + pad(usage, col) + " " + lines[0] + "\n") + for _, line := range lines[1:] { + out.WriteString(strings.Repeat(" ", indent) + line + "\n") + } + // No blank line after a wrapped entry: the reference's template asks for one + // and its whitespace trimming eats it before it reaches the output. +} + +// longAnnotations gives each annotation its own line, which is the room the wide +// layout has and the short one does not. +func longAnnotations(out *strings.Builder, h *Help, withDefault bool) { + if h == nil { + return + } + if len(h.Choices) > 0 { + out.WriteString(" [possible values: " + strings.Join(h.Choices, ", ") + "]\n") + } + if h.Env != "" { + out.WriteString(" [env: " + h.Env + "]\n") + } + if withDefault && len(h.Default) > 0 { + out.WriteString(" (default: " + strings.Join(h.Default, ", ") + ")\n") + } +} + +// writeIndented writes text with every line indented, leaving blank lines blank — +// an indented empty line is trailing whitespace, which the reference does not +// emit. Indenting them instead differs on every page, which is how this was +// settled rather than by reading the template. +func writeIndented(out *strings.Builder, text string, by int) { + prefix := strings.Repeat(" ", by) + for i, line := range strings.Split(text, "\n") { + // The first line carries the indent whatever it holds, and later blank + // lines do not. mise has a command whose description *begins* with an + // empty line, and the reference prints four spaces there and nothing on + // the blank lines below it — a template indenting where it starts writing + // rather than trimming each line. + if line == "" && i > 0 { + out.WriteString("\n") + continue + } + out.WriteString(prefix + line + "\n") + } +} + +// wrap breaks text to a width, preserving the breaks the author already made. +func wrap(text string, width int) []string { + var lines []string + for _, paragraph := range strings.Split(text, "\n") { + if paragraph == "" { + lines = append(lines, "") + continue + } + line := "" + for _, word := range strings.Fields(paragraph) { + if line != "" && runeLen(line)+1+runeLen(word) > width { + lines = append(lines, line) + line = "" + } + if line != "" { + line += " " + } + line += word + } + if line != "" { + lines = append(lines, line) + } + } + if len(lines) == 0 { + lines = append(lines, "") + } + return lines +} + +func runeLen(s string) int { return len([]rune(s)) } + +func firstOf(values ...string) string { + for _, v := range values { + if v != "" { + return v + } + } + return "" +} + +func metaField(h *Help, get func(*Help) string) string { + if h == nil { + return "" + } + return get(h) +} diff --git a/go/argv/page_test.go b/go/argv/page_test.go new file mode 100644 index 000000000..3770c1c27 --- /dev/null +++ b/go/argv/page_test.go @@ -0,0 +1,74 @@ +package argv + +import ( + "strings" + "testing" +) + +// Examples declared once at the root appear on a page that declares none. +// +// The same fallback `BeforeHelp` and `AfterHelp` get. mise declares no root +// examples, so the 211-page parity suite cannot see this in either direction — +// it is checked here against the reference's rule instead. +func TestExamplesFallBackToTheRoot(t *testing.T) { + sub := &Command{Name: "run", Key: 2} + root := &Command{Name: "ex", Key: 1, Subcommands: []*Command{sub}} + help := HelpTable{ + {Key: 1, Examples: []Example{{Header: "Build it", Code: "ex build"}}}, + {Key: 2, Short: "run it"}, + } + spec := HelpSpec{Name: "ex", Bin: "ex"} + + for _, page := range []string{ + ShortHelp(spec, []string{"ex", "run"}, []*Command{root, sub}, help), + LongHelp(spec, []string{"ex", "run"}, []*Command{root, sub}, help), + } { + if !strings.Contains(page, "$ ex build") { + t.Errorf("a page with no examples of its own should show the root's:\n%s", page) + } + } + + // And a command's own win where it has them. + help[1].Examples = []Example{{Code: "ex run --now"}} + page := ShortHelp(spec, []string{"ex", "run"}, []*Command{root, sub}, help) + if strings.Contains(page, "ex build") || !strings.Contains(page, "ex run --now") { + t.Errorf("its own examples should win:\n%s", page) + } +} + +// A description that ends in a break adds no blank line. +// +// clap's `long_about` often ends with one — a `///` block whose last line is +// empty, an examples section written with a trailing newline — and it reaches the +// spec verbatim. The blank line under a description belongs to the renderer, so +// one already in the text was a second one: a stray blank under the about, and in +// the middle of the `Commands:` list. +// +// The rule is usage-lib's and usage-argv's, and mise exercises it — `plugins +// ls-remote` writes its examples that way. It is pinned here as well because the +// parity suite says only that some page differs, not which rule was broken. +func TestADescriptionEndingInABreakAddsNoBlankLine(t *testing.T) { + sub := &Command{Name: "run", Key: 2} + root := &Command{Name: "ex", Key: 1, Subcommands: []*Command{sub}} + help := HelpTable{ + {Key: 1}, + {Key: 2, Short: "run it", Long: "run it\n\nExamples:\n\n $ ex run\n"}, + } + spec := HelpSpec{Name: "ex", Bin: "ex"} + + // On the command's own page, above the usage line. + page := LongHelp(spec, []string{"ex", "run"}, []*Command{root, sub}, help) + if strings.Contains(page, "$ ex run\n\n\nUsage:") { + t.Errorf("the description's own break should not double the blank line:\n%q", page) + } + if !strings.Contains(page, "$ ex run\n\nUsage:") { + t.Errorf("one blank line between the description and the usage:\n%q", page) + } + + // And in the list on the parent's page, where it would leave a stray blank in + // the middle rather than at the end. + parent := LongHelp(spec, []string{"ex"}, []*Command{root}, help) + if strings.Contains(parent, "$ ex run\n\n\n") { + t.Errorf("a listed command's description should not double it either:\n%q", parent) + } +} diff --git a/go/conformance/page_test.go b/go/conformance/page_test.go index 84c2b74c5..9e68637e8 100644 --- a/go/conformance/page_test.go +++ b/go/conformance/page_test.go @@ -4,6 +4,7 @@ import ( "encoding/json" "os/exec" "path/filepath" + "runtime" "strings" "testing" @@ -91,18 +92,48 @@ func TestEveryShortPageMatchesTheReference(t *testing.T) { // firstDiff shows the first line that differs, with a little context — a whole // help page twice over is not something anyone reads. +// firstDiff is where two pages part, with enough around it to see why. +// +// One differing line is rarely the story: a page that gained or lost a line reads +// as a difference at the next line with content, and the cause is above it. So +// this prints a window either side, and the line counts, which say whether the +// two pages are the same length or one drifted. func firstDiff(ours, theirs string) string { mine, ref := strings.Split(ours, "\n"), strings.Split(theirs, "\n") for i := 0; i < len(mine) && i < len(ref); i++ { - if mine[i] != ref[i] { - return " line " + itoa(i+1) + ":\n ours: " + quote(mine[i]) + - "\n lib: " + quote(ref[i]) + if mine[i] == ref[i] { + continue + } + var out strings.Builder + out.WriteString(" line " + itoa(i+1) + " of " + itoa(len(mine)) + + " ours, " + itoa(len(ref)) + " lib:\n") + for j := i - 3; j <= i+3; j++ { + if j < 0 { + continue + } + mark := " " + if j == i { + mark = " > " + } + out.WriteString(mark + itoa(j+1) + " ours: " + quote(at(mine, j)) + "\n") + out.WriteString(mark + itoa(j+1) + " lib: " + quote(at(ref, j)) + "\n") } + return strings.TrimRight(out.String(), "\n") } return " same for " + itoa(min(len(mine), len(ref))) + " lines, then ours has " + itoa(len(mine)) + " and the reference " + itoa(len(ref)) } +// at is a line of a page, or a marker where the page has ended — so a window +// running past the end says so rather than showing an empty line, which is a +// different thing entirely on a page laid out with blank lines. +func at(lines []string, i int) string { + if i >= len(lines) { + return "" + } + return lines[i] +} + func quote(s string) string { b, _ := json.Marshal(s); return string(b) } func itoa(n int) string { b, _ := json.Marshal(n); return string(b) } func min(a, b int) int { @@ -113,3 +144,51 @@ func min(a, b int) int { } var _ = spec.Spec{} + +func TestEveryLongPageMatchesTheReference(t *testing.T) { + usageBin := findUsage(t) + lowered := lowerFile(t, usageBin, filepath.Join("..", "..", "benches", "mise.usage.kdl")) + root, _, help := lowered.BuildAll() + reference := referencePages(t) + spec := lowered.HelpSpec() + + var checked int + var differences []string + var walk func(chain []*argv.Command, path []string) + walk = func(chain []*argv.Command, path []string) { + key := strings.Join(path[1:], " ") + want, ok := reference[key] + if !ok { + // A page the reference does not have is a difference, not a page to + // skip: a comparison that quietly drops what it cannot compare passes + // loudest when the oracle is empty. + differences = append(differences, key+": no reference page") + return + } + if got := argv.LongHelp(spec, path, chain, help); got != want.Long { + differences = append(differences, key+"\n"+firstDiff(got, want.Long)) + } + checked++ + for _, sub := range chain[len(chain)-1].Subcommands { + walk(append(append([]*argv.Command{}, chain...), sub), + append(append([]string{}, path...), sub.Name)) + } + } + walk([]*argv.Command{root}, []string{"mise"}) + + // The floor the short page's test has, for the same reason: "every page + // matched" means nothing without a count of what every page was. + if checked < 200 { + t.Errorf("only %d pages checked; mise's tree is larger", checked) + } + if len(differences) > 0 { + shown := differences + if len(shown) > 2 { + shown = shown[:2] + } + t.Fatalf("%d of %d long pages differ from usage-lib (usage %s, go %s):\n%s", + len(differences), checked, usageBin, runtime.Version(), + strings.Join(shown, "\n")) + } + t.Logf("%d long pages match usage-lib exactly", checked) +} diff --git a/go/conformance/producers_test.go b/go/conformance/producers_test.go index 43b783151..91dd7e916 100644 --- a/go/conformance/producers_test.go +++ b/go/conformance/producers_test.go @@ -65,6 +65,10 @@ func TestTheTwoProducersAgree(t *testing.T) { } walk("mise", root, mise.Root) + // The header a root page prints comes from the spec rather than from any + // command, and it is a table entry like any other. + compare(t, "HelpMeta", lowered.HelpSpec(), mise.HelpMeta) + // And the two cold tables, per entry. Dense from 1 on both sides, which is // what lets a key index them, so a length difference is itself a failure. if len(meta) != len(mise.Meta) { diff --git a/go/internal/shadow/mise/tables.go b/go/internal/shadow/mise/tables.go index aa5437907..c25051f01 100644 --- a/go/internal/shadow/mise/tables.go +++ b/go/internal/shadow/mise/tables.go @@ -4870,7 +4870,7 @@ var HelpText = argv.HelpTable{ {Key: ArgTask, Short: "Task to run", Long: "Task to run.\n\nShorthand for `mise tasks run `."}, {Key: ArgTaskArgs, Hide: true, Short: "Task arguments", Long: "Task arguments"}, {Key: ArgTaskArgsLast, Hide: true}, - {Key: CmdActivate, Short: "Initializes mise in the current shell session", Long: "Initializes mise in the current shell session\n\nThis should go into your shell's rc file or login shell.\nOtherwise, it will only take effect in the current session.\n(e.g. ~/.zshrc, ~/.zprofile, ~/.zshenv, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish, or $PROFILE for powershell)\n\nTypically, this can be added with something like the following:\n\n echo 'eval \"$(mise activate zsh)\"' >> ~/.zshrc\n\nHowever, this requires that \"mise\" is in your PATH. If it is not, you need to\nspecify the full path like this:\n\n echo 'eval \"$(/path/to/mise activate zsh)\"' >> ~/.zshrc\n\nCustomize status output with `status` settings."}, + {Key: CmdActivate, Short: "Initializes mise in the current shell session", Long: "Initializes mise in the current shell session\n\nThis should go into your shell's rc file or login shell.\nOtherwise, it will only take effect in the current session.\n(e.g. ~/.zshrc, ~/.zprofile, ~/.zshenv, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish, or $PROFILE for powershell)\n\nTypically, this can be added with something like the following:\n\n echo 'eval \"$(mise activate zsh)\"' >> ~/.zshrc\n\nHowever, this requires that \"mise\" is in your PATH. If it is not, you need to\nspecify the full path like this:\n\n echo 'eval \"$(/path/to/mise activate zsh)\"' >> ~/.zshrc\n\nCustomize status output with `status` settings.", AfterLongHelp: "Examples:\n\n $ eval \"$(mise activate bash)\"\n $ eval \"$(mise activate zsh)\"\n $ mise activate fish | source\n $ execx($(mise activate xonsh))\n $ (&mise activate pwsh) | Out-String | Invoke-Expression\n"}, {Key: FlagActivateQuiet, Short: "Suppress non-error messages", Long: "Suppress non-error messages"}, {Key: FlagActivateShell, Hide: true, ValueName: "SHELL", ValueDemanded: true, Short: "Shell type to generate the script for", Long: "Shell type to generate the script for", Choices: []string{"bash", "elvish", "fish", "nu", "xonsh", "zsh", "pwsh"}}, {Key: FlagActivateNoHookEnv, Short: "Do not automatically call hook-env", Long: "Do not automatically call hook-env\n\nThis can be helpful for debugging mise. If you run `eval \"$(mise activate --no-hook-env)\"`, then you can call `mise hook-env` manually which will output the env vars to stdout without actually modifying the environment. That way you can do things like `mise hook-env --trace` to get more information or just see the values that hook-env is outputting."}, @@ -4880,28 +4880,28 @@ var HelpText = argv.HelpTable{ {Key: CmdToolAlias, Short: "Manage tool version aliases."}, {Key: FlagToolAliasTool, ValueName: "TOOL", ValueDemanded: true, Short: "Filter aliases by tool", Long: "Filter aliases by tool"}, {Key: FlagToolAliasNoHeader, Short: "Don't show table header", Long: "Don't show table header"}, - {Key: CmdToolAliasGet, Short: "Show an alias for a tool", Long: "Show an alias for a tool\n\nThis is the contents of a tool_alias. entry in ~/.config/mise/config.toml"}, + {Key: CmdToolAliasGet, Short: "Show an alias for a tool", Long: "Show an alias for a tool\n\nThis is the contents of a tool_alias. entry in ~/.config/mise/config.toml", AfterLongHelp: "Examples:\n\n $ mise tool-alias get node lts-hydrogen\n 20.0.0\n"}, {Key: ArgToolAliasGetTool, Demanded: true, Short: "The tool to show the alias for", Long: "The tool to show the alias for"}, {Key: ArgToolAliasGetAlias, Demanded: true, Short: "The alias to show", Long: "The alias to show"}, - {Key: CmdToolAliasLs, Short: "List tool version aliases\nShows the aliases that can be specified.\nThese can come from user config or from plugins in `bin/list-aliases`.", Long: "List tool version aliases\nShows the aliases that can be specified.\nThese can come from user config or from plugins in `bin/list-aliases`.\n\nFor user config, aliases are defined like the following in `~/.config/mise/config.toml`:\n\n [tool_alias.node.versions]\n lts = \"22.0.0\"", VisibleAliases: []string{"list"}}, + {Key: CmdToolAliasLs, Short: "List tool version aliases\nShows the aliases that can be specified.\nThese can come from user config or from plugins in `bin/list-aliases`.", Long: "List tool version aliases\nShows the aliases that can be specified.\nThese can come from user config or from plugins in `bin/list-aliases`.\n\nFor user config, aliases are defined like the following in `~/.config/mise/config.toml`:\n\n [tool_alias.node.versions]\n lts = \"22.0.0\"", VisibleAliases: []string{"list"}, AfterLongHelp: "Examples:\n\n $ mise tool-alias ls\n node lts-jod 22\n"}, {Key: FlagToolAliasLsNoHeader, Short: "Don't show table header", Long: "Don't show table header"}, {Key: ArgToolAliasLsTool, Short: "Show aliases for ", Long: "Show aliases for "}, - {Key: CmdToolAliasSet, Short: "Add/update an alias for a tool/backend", Long: "Add/update an alias for a tool/backend\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"add", "create"}}, + {Key: CmdToolAliasSet, Short: "Add/update an alias for a tool/backend", Long: "Add/update an alias for a tool/backend\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"add", "create"}, AfterLongHelp: "Examples:\n\n $ mise tool-alias set maven asdf:mise-plugins/mise-maven\n $ mise tool-alias set node lts-jod 22.0.0\n"}, {Key: ArgToolAliasSetTool, Demanded: true, Short: "The tool/backend to set the alias for", Long: "The tool/backend to set the alias for"}, {Key: ArgToolAliasSetAlias, Demanded: true, Short: "The alias to set", Long: "The alias to set"}, {Key: ArgToolAliasSetValue, Short: "The value to set the alias to", Long: "The value to set the alias to"}, - {Key: CmdToolAliasUnset, Short: "Clears an alias for a tool/backend", Long: "Clears an alias for a tool/backend\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"rm", "remove", "delete", "del"}}, + {Key: CmdToolAliasUnset, Short: "Clears an alias for a tool/backend", Long: "Clears an alias for a tool/backend\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"rm", "remove", "delete", "del"}, AfterLongHelp: "Examples:\n\n $ mise tool-alias unset maven\n $ mise tool-alias unset node lts-jod\n"}, {Key: ArgToolAliasUnsetTool, Demanded: true, Short: "The tool/backend to remove the alias from", Long: "The tool/backend to remove the alias from"}, {Key: ArgToolAliasUnsetAlias, Short: "The alias to remove", Long: "The alias to remove"}, {Key: CmdAsdf, Hide: true, Short: "[internal] simulates asdf for plugins that call \"asdf\" internally"}, {Key: ArgAsdfArgs, Short: "all arguments", Long: "all arguments"}, - {Key: CmdBackends, Short: "Manage backends"}, - {Key: CmdBackendsLs, Short: "List built-in backends", VisibleAliases: []string{"list"}}, + {Key: CmdBackends, Short: "Manage backends", AfterLongHelp: "Deprecation:\n\nThe `mise b` alias is deprecated and will be removed in mise 2027.4.0.\nUse `mise backends` instead.\n"}, + {Key: CmdBackendsLs, Short: "List built-in backends", VisibleAliases: []string{"list"}, AfterLongHelp: "Examples:\n\n $ mise backends ls\n aqua\n asdf\n cargo\n core\n dotnet\n gem\n go\n npm\n pipx\n spm\n ubi\n vfox\n"}, {Key: CmdBinPaths, Short: "List all the active runtime bin paths"}, {Key: FlagBinPathsBinNames, Short: "Output executable names instead of bin directories", Long: "Output executable names instead of bin directories"}, {Key: FlagBinPathsJson, Short: "Output executable entries in JSON format (implies --bin-names)", Long: "Output executable entries in JSON format (implies --bin-names)"}, {Key: ArgBinPathsToolVersion, Short: "Tool(s) to look up\ne.g.: ruby@3", Long: "Tool(s) to look up\ne.g.: ruby@3"}, - {Key: CmdBootstrap, Short: "Set up a machine for the current config in one command", Long: "Set up a machine for the current config in one command\n\nRuns the bootstrap steps for the current config in order:\n\n0. `mise bootstrap accounts apply` — converge `[bootstrap.users]` and\n `[bootstrap.groups]` (Linux)\n1. `mise bootstrap plugins apply` — install `[bootstrap.plugins]`\n 1.7. `[bootstrap.hooks.pre-packages]` — optional setup hook\n2. Install built-in-manager entries from `[bootstrap.packages]`\n3. `mise bootstrap files apply` — converge `[bootstrap.files]` and\n `[bootstrap.directories]`\n4. `mise bootstrap services apply` — converge `[bootstrap.services]`\n systemd system services (Linux)\n5. `mise bootstrap firewall apply` — converge `[bootstrap.linux.firewall]`\n host firewall policy and rules (Linux)\n6. `mise bootstrap compose apply` — converge `[bootstrap.compose]`\n Docker Compose projects\n7. `mise bootstrap repos apply` — clone/converge `[bootstrap.repos]`\n surrounded by `pre-repos`/`post-repos` hooks\n8. `mise bootstrap dotfiles apply` — apply dotfiles from `[dotfiles]`\n surrounded by `pre-dotfiles`/`post-dotfiles` hooks\n9. `mise bootstrap mise-shell-activate apply` — configure shell activation\n from `[bootstrap.mise_shell_activate]`\n10. `mise bootstrap macos defaults apply` — write\n `[bootstrap.macos.defaults]` entries (macOS)\n surrounded by `pre-defaults`/`post-defaults` hooks\n11. `mise bootstrap macos launchd-agents apply` — install/load\n `[bootstrap.macos.launchd.agents]`\n12. `mise bootstrap linux systemd-units apply` — install/start\n `[bootstrap.linux.systemd.units]`\n13. `mise bootstrap user apply` — set `[bootstrap.user].login_shell`\n (Unix)\n surrounded by `pre-user`/`post-user` hooks\n14. `mise install` — install missing tools from `[tools]`\n surrounded by `pre-tools`/`post-tools` hooks; package-plugin entries\n from `[bootstrap.packages]` install afterward, followed by\n `[bootstrap.hooks.post-packages]`\n15. `mise run bootstrap` — if a task named `bootstrap` is defined\n16. `[bootstrap.hooks.final]` — optional final hook\n\nThe declarative steps converge — anything already in its desired state\nis skipped, so re-running is safe. The `bootstrap` task runs on every\ninvocation; keep it idempotent. Use it for any project-specific setup\nthat doesn't fit the declarative sections (seeding databases, auth flows,\netc.) — it runs with the installed tools on PATH.\n\nUse `--skip ` to skip named parts, or `--only ` to run just\nnamed parts. Both flags can be repeated or comma-separated, but they\ncannot be used together.", VisibleAliases: []string{"bs"}}, + {Key: CmdBootstrap, Short: "Set up a machine for the current config in one command", Long: "Set up a machine for the current config in one command\n\nRuns the bootstrap steps for the current config in order:\n\n0. `mise bootstrap accounts apply` — converge `[bootstrap.users]` and\n `[bootstrap.groups]` (Linux)\n1. `mise bootstrap plugins apply` — install `[bootstrap.plugins]`\n 1.7. `[bootstrap.hooks.pre-packages]` — optional setup hook\n2. Install built-in-manager entries from `[bootstrap.packages]`\n3. `mise bootstrap files apply` — converge `[bootstrap.files]` and\n `[bootstrap.directories]`\n4. `mise bootstrap services apply` — converge `[bootstrap.services]`\n systemd system services (Linux)\n5. `mise bootstrap firewall apply` — converge `[bootstrap.linux.firewall]`\n host firewall policy and rules (Linux)\n6. `mise bootstrap compose apply` — converge `[bootstrap.compose]`\n Docker Compose projects\n7. `mise bootstrap repos apply` — clone/converge `[bootstrap.repos]`\n surrounded by `pre-repos`/`post-repos` hooks\n8. `mise bootstrap dotfiles apply` — apply dotfiles from `[dotfiles]`\n surrounded by `pre-dotfiles`/`post-dotfiles` hooks\n9. `mise bootstrap mise-shell-activate apply` — configure shell activation\n from `[bootstrap.mise_shell_activate]`\n10. `mise bootstrap macos defaults apply` — write\n `[bootstrap.macos.defaults]` entries (macOS)\n surrounded by `pre-defaults`/`post-defaults` hooks\n11. `mise bootstrap macos launchd-agents apply` — install/load\n `[bootstrap.macos.launchd.agents]`\n12. `mise bootstrap linux systemd-units apply` — install/start\n `[bootstrap.linux.systemd.units]`\n13. `mise bootstrap user apply` — set `[bootstrap.user].login_shell`\n (Unix)\n surrounded by `pre-user`/`post-user` hooks\n14. `mise install` — install missing tools from `[tools]`\n surrounded by `pre-tools`/`post-tools` hooks; package-plugin entries\n from `[bootstrap.packages]` install afterward, followed by\n `[bootstrap.hooks.post-packages]`\n15. `mise run bootstrap` — if a task named `bootstrap` is defined\n16. `[bootstrap.hooks.final]` — optional final hook\n\nThe declarative steps converge — anything already in its desired state\nis skipped, so re-running is safe. The `bootstrap` task runs on every\ninvocation; keep it idempotent. Use it for any project-specific setup\nthat doesn't fit the declarative sections (seeding databases, auth flows,\netc.) — it runs with the installed tools on PATH.\n\nUse `--skip ` to skip named parts, or `--only ` to run just\nnamed parts. Both flags can be repeated or comma-separated, but they\ncannot be used together.", VisibleAliases: []string{"bs"}, AfterLongHelp: "Examples:\n\n $ mise bootstrap # packages + repos + dotfiles + tools + bootstrap task\n $ mise bootstrap --force-dotfiles # replace conflicting dotfile targets\n $ mise bootstrap --skip tools,task # skip tool installation and the bootstrap task\n $ mise bootstrap --only tools # run just tool installation\n $ mise bootstrap status --missing\n $ mise bootstrap packages apply --yes\n $ mise bootstrap repos status\n $ mise bootstrap repos apply --dry-run\n $ mise bootstrap dotfiles status\n $ mise bootstrap mise-shell-activate apply --dry-run\n $ mise bootstrap macos defaults status\n $ mise bootstrap macos launchd-agents apply --dry-run\n $ mise bootstrap linux systemd-units apply --dry-run\n $ mise bootstrap user apply --dry-run\n"}, {Key: FlagBootstrapDryRun, Short: "Print what would happen without installing anything", Long: "Print what would happen without installing anything"}, {Key: FlagBootstrapYes, Short: "Skip confirmation prompts", Long: "Skip confirmation prompts"}, {Key: FlagBootstrapForceDotfiles, Short: "Overwrite existing files that conflict with whole-file dotfile entries", Long: "Overwrite existing files that conflict with whole-file dotfile entries"}, @@ -4930,7 +4930,7 @@ var HelpText = argv.HelpTable{ {Key: FlagBootstrapComposeStatusJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagBootstrapComposeStatusMissing, Short: "Exit with code 1 when any Compose project is not converged", Long: "Exit with code 1 when any Compose project is not converged"}, {Key: CmdBootstrapDotfiles, Short: "Manage dotfiles from `[dotfiles]`"}, - {Key: CmdBootstrapDotfilesAdd, Short: "Add or update dotfiles in `[dotfiles]`", Long: "Add or update dotfiles in `[dotfiles]`\n\nIf the target is already managed, this updates its source from the live\ntarget. Otherwise it creates a `[dotfiles]` entry and seeds the source\nunder `dotfiles.root` unless `--source` is provided."}, + {Key: CmdBootstrapDotfilesAdd, Short: "Add or update dotfiles in `[dotfiles]`", Long: "Add or update dotfiles in `[dotfiles]`\n\nIf the target is already managed, this updates its source from the live\ntarget. Otherwise it creates a `[dotfiles]` entry and seeds the source\nunder `dotfiles.root` unless `--source` is provided.", AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles add ~/.zshrc\n $ mise bootstrap dotfiles add --mode copy ~/.config/starship.toml\n $ mise bootstrap dotfiles add --source dotfiles/gitconfig ~/.gitconfig\n"}, {Key: FlagBootstrapDotfilesAddForce, Short: "Overwrite existing sources without prompting", Long: "Overwrite existing sources without prompting"}, {Key: FlagBootstrapDotfilesAddGlobal, Short: "Write to the global config", Long: "Write to the global config"}, {Key: FlagBootstrapDotfilesAddLocal, Short: "Write to the local config instead of the global config", Long: "Write to the local config instead of the global config"}, @@ -4941,22 +4941,22 @@ var HelpText = argv.HelpTable{ {Key: FlagBootstrapDotfilesAddSource, ValueName: "PATH", ValueDemanded: true, Short: "Source path to use for a single target", Long: "Source path to use for a single target"}, {Key: FlagBootstrapDotfilesAddYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, {Key: ArgBootstrapDotfilesAddTarget, Demanded: true, Short: "Targets to add or update", Long: "Targets to add or update"}, - {Key: CmdBootstrapDotfilesApply, Short: "Apply dotfiles from `[dotfiles]`", Long: "Apply dotfiles from `[dotfiles]`\n\nApplies configured whole-file entries and edits that aren't in their\ndesired state. Whole-file entries may symlink, copy, or render templates.\nEdit entries manage a marker-delimited block or a single line in a file\nmise doesn't otherwise own."}, + {Key: CmdBootstrapDotfilesApply, Short: "Apply dotfiles from `[dotfiles]`", Long: "Apply dotfiles from `[dotfiles]`\n\nApplies configured whole-file entries and edits that aren't in their\ndesired state. Whole-file entries may symlink, copy, or render templates.\nEdit entries manage a marker-delimited block or a single line in a file\nmise doesn't otherwise own.", AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles apply\n $ mise bootstrap dotfiles apply --dry-run\n $ mise bootstrap dotfiles apply --force --yes\n"}, {Key: FlagBootstrapDotfilesApplyForce, Short: "Overwrite existing files that conflict with whole-file dotfile entries", Long: "Overwrite existing files that conflict with whole-file dotfile entries"}, {Key: FlagBootstrapDotfilesApplyDryRun, Short: "Print the actions that would run without writing anything", Long: "Print the actions that would run without writing anything"}, {Key: FlagBootstrapDotfilesApplyYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, {Key: ArgBootstrapDotfilesApplyTarget, Short: "Only apply these targets", Long: "Only apply these targets"}, - {Key: CmdBootstrapDotfilesEdit, Short: "Edit a managed dotfile source"}, + {Key: CmdBootstrapDotfilesEdit, Short: "Edit a managed dotfile source", AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles edit ~/.zshrc\n $ mise bootstrap dotfiles edit --apply ~/.config/starship.toml\n"}, {Key: FlagBootstrapDotfilesEditApply, Short: "Apply this target after the editor exits", Long: "Apply this target after the editor exits"}, {Key: FlagBootstrapDotfilesEditMode, ValueName: "MODE", ValueDemanded: true, Short: "Dotfile mode to use if the target is not yet managed", Long: "Dotfile mode to use if the target is not yet managed"}, {Key: FlagBootstrapDotfilesEditSource, ValueName: "PATH", ValueDemanded: true, Short: "Source path to use if the target is not yet managed", Long: "Source path to use if the target is not yet managed"}, {Key: FlagBootstrapDotfilesEditYes, Short: "Skip the confirmation prompt when adding an unmanaged target", Long: "Skip the confirmation prompt when adding an unmanaged target"}, {Key: ArgBootstrapDotfilesEditTarget, Demanded: true, Short: "Target to edit", Long: "Target to edit"}, - {Key: CmdBootstrapDotfilesStatus, Short: "Show the status of dotfiles from `[dotfiles]`", VisibleAliases: []string{"ls"}}, + {Key: CmdBootstrapDotfilesStatus, Short: "Show the status of dotfiles from `[dotfiles]`", VisibleAliases: []string{"ls"}, AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles status\n $ mise bootstrap dotfiles status ~/.zshrc\n $ mise bootstrap dotfiles status --json\n $ mise bootstrap dotfiles status --missing # exit 1 if anything is out of sync\n"}, {Key: FlagBootstrapDotfilesStatusJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagBootstrapDotfilesStatusMissing, Short: "Exit with code 1 if any configured dotfiles are not in their desired\nstate (missing, source missing, differs)", Long: "Exit with code 1 if any configured dotfiles are not in their desired\nstate (missing, source missing, differs)"}, {Key: ArgBootstrapDotfilesStatusTarget, Short: "Only show these targets", Long: "Only show these targets"}, - {Key: CmdBootstrapDotfilesUnapply, Short: "Remove dotfiles applied from `[dotfiles]`", Long: "Remove dotfiles applied from `[dotfiles]`\n\nRemoves configured whole-file entries and edits while preserving files\nmise cannot identify as managed. Modified copies, templates, and plain-line\nedits require `--force`."}, + {Key: CmdBootstrapDotfilesUnapply, Short: "Remove dotfiles applied from `[dotfiles]`", Long: "Remove dotfiles applied from `[dotfiles]`\n\nRemoves configured whole-file entries and edits while preserving files\nmise cannot identify as managed. Modified copies, templates, and plain-line\nedits require `--force`.", AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles unapply\n $ mise bootstrap dotfiles unapply ~/.zshrc\n $ mise bootstrap dotfiles unapply --dry-run\n $ mise bootstrap dotfiles unapply --force --yes\n"}, {Key: FlagBootstrapDotfilesUnapplyForce, Short: "Remove modified or otherwise ambiguous managed files and lines", Long: "Remove modified or otherwise ambiguous managed files and lines"}, {Key: FlagBootstrapDotfilesUnapplyDryRun, Short: "Print the actions that would run without writing anything", Long: "Print the actions that would run without writing anything"}, {Key: FlagBootstrapDotfilesUnapplyYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, @@ -5022,44 +5022,44 @@ var HelpText = argv.HelpTable{ {Key: FlagBootstrapMiseShellActivateStatusJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagBootstrapMiseShellActivateStatusMissing, Short: "Exit with code 1 if any configured shell activation is not in its desired state", Long: "Exit with code 1 if any configured shell activation is not in its desired state"}, {Key: CmdBootstrapPackages, Short: "Manage bootstrap system packages from `[bootstrap.packages]`"}, - {Key: CmdBootstrapPackagesApply, Short: "Apply system packages from `[bootstrap.packages]`", Long: "Apply system packages from `[bootstrap.packages]`\n\nChecks which configured packages are missing and installs them with the\nsystem package manager. Built-in system managers may elevate with sudo when\nnot running as root (see `system_packages.sudo`); package plugins never do.\n\nPackages can also be given explicitly in `manager:package` form (e.g.\n`apk:zlib-dev`, `apt:curl`, `brew:jq`); they are installed whether or not they appear in\nthe config. Explicit packages and `--manager` scope the run to packages\nonly. `install` is accepted as an alias for this command.", VisibleAliases: []string{"i"}}, + {Key: CmdBootstrapPackagesApply, Short: "Apply system packages from `[bootstrap.packages]`", Long: "Apply system packages from `[bootstrap.packages]`\n\nChecks which configured packages are missing and installs them with the\nsystem package manager. Built-in system managers may elevate with sudo when\nnot running as root (see `system_packages.sudo`); package plugins never do.\n\nPackages can also be given explicitly in `manager:package` form (e.g.\n`apk:zlib-dev`, `apt:curl`, `brew:jq`); they are installed whether or not they appear in\nthe config. Explicit packages and `--manager` scope the run to packages\nonly. `install` is accepted as an alias for this command.", VisibleAliases: []string{"i"}, AfterLongHelp: "Examples:\n\n $ mise bootstrap packages apply\n $ mise bootstrap packages apply apk:zlib-dev apt:curl brew:jq brew-cask:firefox flatpak:org.mozilla.firefox mas:497799835\n $ mise bootstrap packages apply --dry-run\n $ mise bootstrap packages apply --manager apt --yes\n"}, {Key: FlagBootstrapPackagesApplyManager, ValueName: "MANAGER", ValueDemanded: true, Short: "Only install packages for this built-in or plugin manager", Long: "Only install packages for this built-in or plugin manager"}, {Key: FlagBootstrapPackagesApplyDryRun, Short: "Print the commands that would run without running them", Long: "Print the commands that would run without running them"}, {Key: FlagBootstrapPackagesApplyYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, {Key: FlagBootstrapPackagesApplyUpdate, Short: "Refresh package manager metadata first (apk: `--update-cache`, apt: `apt-get update`)", Long: "Refresh package manager metadata first (apk: `--update-cache`, apt: `apt-get update`)"}, {Key: ArgBootstrapPackagesApplyPackage, Short: "Packages in `manager:package` form; defaults to everything configured in [bootstrap.packages]", Long: "Packages in `manager:package` form; defaults to everything configured in [bootstrap.packages]"}, {Key: CmdBootstrapPackagesBrew, Short: "Manage Homebrew taps used by bootstrap packages", Long: "Manage Homebrew taps used by bootstrap packages\n\nThese commands edit `[bootstrap.brew.taps]` so tapped formulae and casks\ncan be fetched directly by mise without a Homebrew installation."}, - {Key: CmdBootstrapPackagesBrewTap, Short: "Add a Homebrew tap URL to [bootstrap.brew.taps]"}, + {Key: CmdBootstrapPackagesBrewTap, Short: "Add a Homebrew tap URL to [bootstrap.brew.taps]", AfterLongHelp: "Examples:\n\n $ mise bootstrap packages brew tap railwaycat/emacsmacport\n $ mise bootstrap packages brew tap acme/tools https://github.com/acme/homebrew-tools.git\n"}, {Key: FlagBootstrapPackagesBrewTapLocal, Short: "Write to the local config instead of the global config", Long: "Write to the local config instead of the global config"}, {Key: FlagBootstrapPackagesBrewTapDryRun, Short: "Print the config change without writing it", Long: "Print the config change without writing it"}, {Key: FlagBootstrapPackagesBrewTapPath, ValueName: "PATH", ValueDemanded: true, Short: "Write to this config file or directory", Long: "Write to this config file or directory"}, {Key: ArgBootstrapPackagesBrewTapTap, Demanded: true, Short: "Tap name, e.g. `owner/repo`", Long: "Tap name, e.g. `owner/repo`"}, {Key: ArgBootstrapPackagesBrewTapUrl, Short: "GitHub URL for the tap. Defaults to https://github.com//homebrew-.git", Long: "GitHub URL for the tap. Defaults to https://github.com//homebrew-.git"}, - {Key: CmdBootstrapPackagesBrewUntap, Short: "Remove Homebrew tap URLs from [bootstrap.brew.taps]", VisibleAliases: []string{"remove", "rm"}}, + {Key: CmdBootstrapPackagesBrewUntap, Short: "Remove Homebrew tap URLs from [bootstrap.brew.taps]", VisibleAliases: []string{"remove", "rm"}, AfterLongHelp: "Examples:\n\n $ mise bootstrap packages brew untap railwaycat/emacsmacport\n"}, {Key: FlagBootstrapPackagesBrewUntapLocal, Short: "Write to the local config instead of the global config", Long: "Write to the local config instead of the global config"}, {Key: FlagBootstrapPackagesBrewUntapDryRun, Short: "Print the config change without writing it", Long: "Print the config change without writing it"}, {Key: FlagBootstrapPackagesBrewUntapPath, ValueName: "PATH", ValueDemanded: true, Short: "Write to this config file or directory", Long: "Write to this config file or directory"}, {Key: ArgBootstrapPackagesBrewUntapTaps, Demanded: true, Short: "Tap name(s), e.g. `owner/repo`", Long: "Tap name(s), e.g. `owner/repo`"}, - {Key: CmdBootstrapPackagesImport, Short: "Import installed system packages into `[bootstrap.packages]`", Long: "Import installed system packages into `[bootstrap.packages]`\n\nCurrently supports Homebrew formulae only. By default, imports linked\nformulae whose active keg receipt says they were installed on request.\nPass `--all` to import every linked formula, including dependencies."}, + {Key: CmdBootstrapPackagesImport, Short: "Import installed system packages into `[bootstrap.packages]`", Long: "Import installed system packages into `[bootstrap.packages]`\n\nCurrently supports Homebrew formulae only. By default, imports linked\nformulae whose active keg receipt says they were installed on request.\nPass `--all` to import every linked formula, including dependencies.", AfterLongHelp: "Examples:\n\n $ mise bootstrap packages import --manager brew\n $ mise bootstrap packages import --manager brew --all\n $ mise bootstrap packages import --manager brew --global\n $ mise bootstrap packages import --manager brew --dry-run\n"}, {Key: FlagBootstrapPackagesImportEnv, ValueName: "ENV", ValueDemanded: true, Short: "Write to the config file for this environment (mise..toml)", Long: "Write to the config file for this environment (mise..toml)"}, {Key: FlagBootstrapPackagesImportGlobal, Short: "Write to the global config (~/.config/mise/config.toml)", Long: "Write to the global config (~/.config/mise/config.toml)"}, {Key: FlagBootstrapPackagesImportManager, ValueName: "MANAGER", ValueDemanded: true, Short: "Only import packages for this manager. Currently only `brew` is supported", Long: "Only import packages for this manager. Currently only `brew` is supported", Choices: []string{"brew"}, Default: []string{"brew"}}, {Key: FlagBootstrapPackagesImportAll, Short: "Import every linked formula, including dependencies", Long: "Import every linked formula, including dependencies"}, {Key: FlagBootstrapPackagesImportDryRun, Short: "Print the config change without writing config", Long: "Print the config change without writing config"}, {Key: FlagBootstrapPackagesImportPath, ValueName: "PATH", ValueDemanded: true, Short: "Write to this config file or directory", Long: "Write to this config file or directory"}, - {Key: CmdBootstrapPackagesPrune, Short: "Prune installed system packages no longer declared in `[bootstrap.packages]`", Long: "Prune installed system packages no longer declared in `[bootstrap.packages]`\n\nCurrently supports Homebrew formulae only. Pruning removes linked formulae\nthat are not needed by the current config or by trusted, loadable tracked\nconfigs."}, + {Key: CmdBootstrapPackagesPrune, Short: "Prune installed system packages no longer declared in `[bootstrap.packages]`", Long: "Prune installed system packages no longer declared in `[bootstrap.packages]`\n\nCurrently supports Homebrew formulae only. Pruning removes linked formulae\nthat are not needed by the current config or by trusted, loadable tracked\nconfigs.", AfterLongHelp: "Examples:\n\n $ mise bootstrap packages prune --manager brew\n $ mise bootstrap packages prune --manager brew --dry-run\n $ mise bootstrap packages prune --manager brew --yes\n"}, {Key: FlagBootstrapPackagesPruneManager, ValueName: "MANAGER", ValueDemanded: true, Short: "Only prune packages for this manager. Currently only `brew` is supported", Long: "Only prune packages for this manager. Currently only `brew` is supported", Choices: []string{"brew"}, Default: []string{"brew"}}, {Key: FlagBootstrapPackagesPruneDryRun, Short: "Print what would be removed without deleting anything", Long: "Print what would be removed without deleting anything"}, {Key: FlagBootstrapPackagesPruneYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, - {Key: CmdBootstrapPackagesStatus, Short: "Show the status of system packages from `[bootstrap.packages]`", VisibleAliases: []string{"ls"}}, + {Key: CmdBootstrapPackagesStatus, Short: "Show the status of system packages from `[bootstrap.packages]`", VisibleAliases: []string{"ls"}, AfterLongHelp: "Examples:\n\n $ mise bootstrap packages status\n $ mise bootstrap packages status --json\n $ mise bootstrap packages status --missing # exit 1 if anything is out of sync\n"}, {Key: FlagBootstrapPackagesStatusJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagBootstrapPackagesStatusMissing, Short: "Exit with code 1 if any configured packages are not in their desired state", Long: "Exit with code 1 if any configured packages are not in their desired state"}, - {Key: CmdBootstrapPackagesUpgrade, Short: "Upgrade installed bootstrap packages from `[bootstrap.packages]`", Long: "Upgrade installed bootstrap packages from `[bootstrap.packages]`\n\nRefreshes package manager metadata and upgrades the configured packages\nthat are already installed: apk/apt/dnf/pacman upgrade to the newest available\nversion (apk, apt, and dnf honor a version pinned in config), brew pours the\nformula's current bottle and replaces the old keg, brew-cask installs\nthe current cask artifact, flatpak updates applications and runtimes, and mas upgrades App Store apps. Packages that\nare not installed yet are skipped — use `mise bootstrap packages apply`\nfor those.\n\nPackages can also be given explicitly in `manager:package` form.", VisibleAliases: []string{"up"}}, + {Key: CmdBootstrapPackagesUpgrade, Short: "Upgrade installed bootstrap packages from `[bootstrap.packages]`", Long: "Upgrade installed bootstrap packages from `[bootstrap.packages]`\n\nRefreshes package manager metadata and upgrades the configured packages\nthat are already installed: apk/apt/dnf/pacman upgrade to the newest available\nversion (apk, apt, and dnf honor a version pinned in config), brew pours the\nformula's current bottle and replaces the old keg, brew-cask installs\nthe current cask artifact, flatpak updates applications and runtimes, and mas upgrades App Store apps. Packages that\nare not installed yet are skipped — use `mise bootstrap packages apply`\nfor those.\n\nPackages can also be given explicitly in `manager:package` form.", VisibleAliases: []string{"up"}, AfterLongHelp: "Examples:\n\n $ mise bootstrap packages upgrade\n $ mise bootstrap packages upgrade brew:postgresql@17\n $ mise bootstrap packages upgrade --manager brew-cask\n $ mise bootstrap packages upgrade --manager mas\n $ mise bootstrap packages upgrade --manager apt --yes\n $ mise bootstrap packages upgrade --dry-run\n"}, {Key: FlagBootstrapPackagesUpgradeManager, ValueName: "MANAGER", ValueDemanded: true, Short: "Only upgrade packages for this built-in or plugin manager", Long: "Only upgrade packages for this built-in or plugin manager"}, {Key: FlagBootstrapPackagesUpgradeDryRun, Short: "Print the commands that would run without running them", Long: "Print the commands that would run without running them"}, {Key: FlagBootstrapPackagesUpgradeYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, {Key: ArgBootstrapPackagesUpgradePackage, Short: "Packages in `manager:package` form; defaults to everything configured in [bootstrap.packages]", Long: "Packages in `manager:package` form; defaults to everything configured in [bootstrap.packages]"}, - {Key: CmdBootstrapPackagesUse, Short: "Add bootstrap packages to [bootstrap.packages] and install them", Long: "Add bootstrap packages to [bootstrap.packages] and install them\n\nLike `mise use` for tools: writes `\"manager:package\" = \"version\"` entries\nto mise.toml (the local config by default, the global one with `-g`) and\nthen installs whatever is missing.\n\nVersions are pinned with `@`: `mise bootstrap packages use apt:curl@8.5.0-2`. Without\n`@` (or with `@latest`) no pin is written. brew formulae and casks\nversion through their names instead (for example `brew:postgresql@17`,\n`brew-cask:temurin@17`), where `@` is part of the Homebrew name rather than\na mise version selector. mas uses numeric ADAM IDs and does not support pins.", VisibleAliases: []string{"u"}}, + {Key: CmdBootstrapPackagesUse, Short: "Add bootstrap packages to [bootstrap.packages] and install them", Long: "Add bootstrap packages to [bootstrap.packages] and install them\n\nLike `mise use` for tools: writes `\"manager:package\" = \"version\"` entries\nto mise.toml (the local config by default, the global one with `-g`) and\nthen installs whatever is missing.\n\nVersions are pinned with `@`: `mise bootstrap packages use apt:curl@8.5.0-2`. Without\n`@` (or with `@latest`) no pin is written. brew formulae and casks\nversion through their names instead (for example `brew:postgresql@17`,\n`brew-cask:temurin@17`), where `@` is part of the Homebrew name rather than\na mise version selector. mas uses numeric ADAM IDs and does not support pins.", VisibleAliases: []string{"u"}, AfterLongHelp: "Examples:\n\n $ mise bootstrap packages use apk:zlib-dev apt:curl brew:jq brew-cask:firefox flatpak:org.mozilla.firefox mas:497799835\n $ mise bootstrap packages use -g brew:postgresql@17\n $ mise bootstrap packages use apt:curl@8.5.0-2\n"}, {Key: FlagBootstrapPackagesUseEnv, ValueName: "ENV", ValueDemanded: true, Short: "Write to the config file for this environment (mise..toml)", Long: "Write to the config file for this environment (mise..toml)"}, {Key: FlagBootstrapPackagesUseGlobal, Short: "Write to the global config (~/.config/mise/config.toml) instead of the local one", Long: "Write to the global config (~/.config/mise/config.toml) instead of the local one"}, {Key: FlagBootstrapPackagesUseDryRun, Short: "Print the commands that would run without writing config or installing", Long: "Print the commands that would run without writing config or installing"}, @@ -5156,36 +5156,36 @@ var HelpText = argv.HelpTable{ {Key: CmdCacheTask, Short: "Inspect output cache entries for a task"}, {Key: FlagCacheTaskJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: ArgCacheTaskTask, Demanded: true, Short: "Task name or pattern to inspect", Long: "Task name or pattern to inspect"}, - {Key: CmdCompletion, Short: "Generate shell completions"}, + {Key: CmdCompletion, Short: "Generate shell completions", AfterLongHelp: "Examples:\n\n $ mise completion bash --include-bash-completion-lib > ~/.local/share/bash-completion/completions/mise\n $ mise completion zsh > /usr/local/share/zsh/site-functions/_mise\n $ mise completion fish > ~/.config/fish/completions/mise.fish\n $ mise completion powershell >> $PROFILE\n"}, {Key: FlagCompletionShell, Hide: true, ValueName: "SHELL_TYPE", ValueDemanded: true, Short: "Shell type to generate completions for", Long: "Shell type to generate completions for", Choices: []string{"bash", "fish", "powershell", "zsh"}}, {Key: FlagCompletionIncludeBashCompletionLib, Short: "Include the bash completion library in the bash completion script", Long: "Include the bash completion library in the bash completion script\n\nThis is required for completions to work in bash, but it is not included by default\nyou may source it separately or enable this flag to enable it in the script."}, {Key: FlagCompletionUsage, Hide: true, Short: "Always use usage for completions.\nCurrently, usage is the default for fish and bash but not zsh since it has a few quirks\nto work out first.", Long: "Always use usage for completions.\nCurrently, usage is the default for fish and bash but not zsh since it has a few quirks\nto work out first.\n\nThis requires the `usage` CLI to be installed.\nhttps://usage.jdx.dev"}, {Key: ArgCompletionShell, Short: "Shell type to generate completions for", Long: "Shell type to generate completions for", Choices: []string{"bash", "fish", "powershell", "zsh"}}, - {Key: CmdConfig, Short: "Manage config files", VisibleAliases: []string{"cfg"}}, + {Key: CmdConfig, Short: "Manage config files", VisibleAliases: []string{"cfg"}, AfterLongHelp: "Examples:\n\n $ mise config ls\n Path Tools\n ~/.config/mise/config.toml pitchfork\n ~/src/mise/mise.toml actionlint, bun, cargo-binstall, cargo:cargo-insta\n"}, {Key: FlagConfigJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagConfigNoHeader, Short: "Do not print table header", Long: "Do not print table header"}, {Key: FlagConfigTrackedConfigs, Short: "List all tracked config files", Long: "List all tracked config files"}, - {Key: CmdConfigGet, Short: "Display the value of a setting in a mise.toml file"}, + {Key: CmdConfigGet, Short: "Display the value of a setting in a mise.toml file", AfterLongHelp: "Examples:\n\n $ mise toml get tools.python\n 3.12\n"}, {Key: FlagConfigGetFile, ValueName: "FILE", ValueDemanded: true, Short: "The path to the mise.toml file to read", Long: "The path to the mise.toml file to read\n\nCan be a file path or directory. If a directory is provided, the config file in that directory is used.\n\nIf not provided, the nearest mise.toml file will be used"}, {Key: ArgConfigGetKey, Short: "The path of the config to display", Long: "The path of the config to display"}, - {Key: CmdConfigLs, Short: "List config files currently in use", VisibleAliases: []string{"list"}}, + {Key: CmdConfigLs, Short: "List config files currently in use", VisibleAliases: []string{"list"}, AfterLongHelp: "Examples:\n\n $ mise config ls\n Path Tools\n ~/.config/mise/config.toml pitchfork\n ~/src/mise/mise.toml actionlint, bun, cargo-binstall, cargo:cargo-insta\n"}, {Key: FlagConfigLsJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagConfigLsNoHeader, Short: "Do not print table header", Long: "Do not print table header"}, {Key: FlagConfigLsTrackedConfigs, Short: "List all tracked config files", Long: "List all tracked config files"}, - {Key: CmdConfigSet, Short: "Set the value of a setting in a mise.toml file"}, + {Key: CmdConfigSet, Short: "Set the value of a setting in a mise.toml file", AfterLongHelp: "Examples:\n\n $ mise config set tools.python 3.12\n $ mise config set settings.always_keep_download true\n $ mise config set env.TEST_ENV_VAR ABC\n $ mise config set settings.disable_tools node,rust\n\n # Type for `settings` is inferred\n $ mise config set settings.jobs 4\n"}, {Key: FlagConfigSetFile, ValueName: "FILE", ValueDemanded: true, Short: "The path to the mise.toml file to edit", Long: "The path to the mise.toml file to edit\n\nCan be a file path or directory. If a directory is provided, the config file in that directory is used.\n\nIf not provided, the nearest mise.toml file will be used"}, {Key: FlagConfigSetType, ValueName: "TYPE", ValueDemanded: true, Choices: []string{"infer", "string", "integer", "float", "bool", "list", "set"}, Default: []string{"infer"}}, {Key: ArgConfigSetKey, Demanded: true, Short: "The path of the config to display", Long: "The path of the config to display"}, {Key: ArgConfigSetValue, Short: "The value to set the key to (optional if provided as KEY=VALUE)", Long: "The value to set the key to (optional if provided as KEY=VALUE)"}, - {Key: CmdCurrent, Hide: true, Short: "Shows current active and installed runtime versions", Long: "Shows current active and installed runtime versions\n\nThis is similar to `mise ls --current`, but this only shows the runtime\nand/or version. It's designed to fit into scripts more easily."}, + {Key: CmdCurrent, Hide: true, Short: "Shows current active and installed runtime versions", Long: "Shows current active and installed runtime versions\n\nThis is similar to `mise ls --current`, but this only shows the runtime\nand/or version. It's designed to fit into scripts more easily.", AfterLongHelp: "Examples:\n\n # outputs `.tool-versions` compatible format\n $ mise current\n python 3.11.0 3.10.0\n shfmt 3.6.0\n shellcheck 0.9.0\n node 20.0.0\n\n $ mise current node\n 20.0.0\n\n # can output multiple versions\n $ mise current python\n 3.11.0 3.10.0\n"}, {Key: ArgCurrentPlugin, Short: "Plugin to show versions of e.g.: ruby, node, cargo:eza, npm:prettier, etc", Long: "Plugin to show versions of e.g.: ruby, node, cargo:eza, npm:prettier, etc"}, - {Key: CmdDeactivate, Short: "Disable mise for current shell session", Long: "Disable mise for current shell session\n\nThis can be used to temporarily disable mise in a shell session."}, + {Key: CmdDeactivate, Short: "Disable mise for current shell session", Long: "Disable mise for current shell session\n\nThis can be used to temporarily disable mise in a shell session.", AfterLongHelp: "Examples:\n\n $ mise deactivate\n"}, {Key: CmdDirenv, Hide: true, Short: "Output direnv function to use mise inside direnv", Long: "Output direnv function to use mise inside direnv\n\nSee https://mise.jdx.dev/direnv.html for more information\n\nBecause this generates the idiomatic files based on currently installed plugins,\nyou should run this command after installing new plugins. Otherwise\ndirenv may not know to update environment variables when idiomatic file versions change."}, - {Key: CmdDirenvActivate, Hide: true, Short: "Output direnv function to use mise inside direnv", Long: "Output direnv function to use mise inside direnv\n\nSee https://mise.jdx.dev/direnv.html for more information\n\nBecause this generates the idiomatic files based on currently installed plugins,\nyou should run this command after installing new plugins. Otherwise\ndirenv may not know to update environment variables when idiomatic file versions change."}, + {Key: CmdDirenvActivate, Hide: true, Short: "Output direnv function to use mise inside direnv", Long: "Output direnv function to use mise inside direnv\n\nSee https://mise.jdx.dev/direnv.html for more information\n\nBecause this generates the idiomatic files based on currently installed plugins,\nyou should run this command after installing new plugins. Otherwise\ndirenv may not know to update environment variables when idiomatic file versions change.", AfterLongHelp: "Examples:\n\n $ mise direnv activate > ~/.config/direnv/lib/use_mise.sh\n $ echo 'use mise' > .envrc\n $ direnv allow\n"}, {Key: CmdDirenvEnvrc, Hide: true, Short: "[internal] This is an internal command that writes an envrc file\nfor direnv to consume."}, {Key: CmdDirenvExec, Hide: true, Short: "[internal] This is an internal command that writes an envrc file\nfor direnv to consume."}, {Key: CmdDotfiles, Hide: true, Short: "Manage dotfiles from `[dotfiles]` (deprecated)", Long: "Manage dotfiles from `[dotfiles]` (deprecated)\n\nUse `mise bootstrap dotfiles` instead."}, - {Key: CmdDotfilesAdd, Hide: true, Short: "Add or update dotfiles in `[dotfiles]`", Long: "Add or update dotfiles in `[dotfiles]`\n\nIf the target is already managed, this updates its source from the live\ntarget. Otherwise it creates a `[dotfiles]` entry and seeds the source\nunder `dotfiles.root` unless `--source` is provided."}, + {Key: CmdDotfilesAdd, Hide: true, Short: "Add or update dotfiles in `[dotfiles]`", Long: "Add or update dotfiles in `[dotfiles]`\n\nIf the target is already managed, this updates its source from the live\ntarget. Otherwise it creates a `[dotfiles]` entry and seeds the source\nunder `dotfiles.root` unless `--source` is provided.", AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles add ~/.zshrc\n $ mise bootstrap dotfiles add --mode copy ~/.config/starship.toml\n $ mise bootstrap dotfiles add --source dotfiles/gitconfig ~/.gitconfig\n"}, {Key: FlagDotfilesAddForce, Short: "Overwrite existing sources without prompting", Long: "Overwrite existing sources without prompting"}, {Key: FlagDotfilesAddGlobal, Short: "Write to the global config", Long: "Write to the global config"}, {Key: FlagDotfilesAddLocal, Short: "Write to the local config instead of the global config", Long: "Write to the local config instead of the global config"}, @@ -5196,34 +5196,34 @@ var HelpText = argv.HelpTable{ {Key: FlagDotfilesAddSource, ValueName: "PATH", ValueDemanded: true, Short: "Source path to use for a single target", Long: "Source path to use for a single target"}, {Key: FlagDotfilesAddYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, {Key: ArgDotfilesAddTarget, Demanded: true, Short: "Targets to add or update", Long: "Targets to add or update"}, - {Key: CmdDotfilesApply, Hide: true, Short: "Apply dotfiles from `[dotfiles]`", Long: "Apply dotfiles from `[dotfiles]`\n\nApplies configured whole-file entries and edits that aren't in their\ndesired state. Whole-file entries may symlink, copy, or render templates.\nEdit entries manage a marker-delimited block or a single line in a file\nmise doesn't otherwise own."}, + {Key: CmdDotfilesApply, Hide: true, Short: "Apply dotfiles from `[dotfiles]`", Long: "Apply dotfiles from `[dotfiles]`\n\nApplies configured whole-file entries and edits that aren't in their\ndesired state. Whole-file entries may symlink, copy, or render templates.\nEdit entries manage a marker-delimited block or a single line in a file\nmise doesn't otherwise own.", AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles apply\n $ mise bootstrap dotfiles apply --dry-run\n $ mise bootstrap dotfiles apply --force --yes\n"}, {Key: FlagDotfilesApplyForce, Short: "Overwrite existing files that conflict with whole-file dotfile entries", Long: "Overwrite existing files that conflict with whole-file dotfile entries"}, {Key: FlagDotfilesApplyDryRun, Short: "Print the actions that would run without writing anything", Long: "Print the actions that would run without writing anything"}, {Key: FlagDotfilesApplyYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, {Key: ArgDotfilesApplyTarget, Short: "Only apply these targets", Long: "Only apply these targets"}, - {Key: CmdDotfilesEdit, Hide: true, Short: "Edit a managed dotfile source"}, + {Key: CmdDotfilesEdit, Hide: true, Short: "Edit a managed dotfile source", AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles edit ~/.zshrc\n $ mise bootstrap dotfiles edit --apply ~/.config/starship.toml\n"}, {Key: FlagDotfilesEditApply, Short: "Apply this target after the editor exits", Long: "Apply this target after the editor exits"}, {Key: FlagDotfilesEditMode, ValueName: "MODE", ValueDemanded: true, Short: "Dotfile mode to use if the target is not yet managed", Long: "Dotfile mode to use if the target is not yet managed"}, {Key: FlagDotfilesEditSource, ValueName: "PATH", ValueDemanded: true, Short: "Source path to use if the target is not yet managed", Long: "Source path to use if the target is not yet managed"}, {Key: FlagDotfilesEditYes, Short: "Skip the confirmation prompt when adding an unmanaged target", Long: "Skip the confirmation prompt when adding an unmanaged target"}, {Key: ArgDotfilesEditTarget, Demanded: true, Short: "Target to edit", Long: "Target to edit"}, - {Key: CmdDotfilesStatus, Hide: true, Short: "Show the status of dotfiles from `[dotfiles]`", VisibleAliases: []string{"ls"}}, + {Key: CmdDotfilesStatus, Hide: true, Short: "Show the status of dotfiles from `[dotfiles]`", VisibleAliases: []string{"ls"}, AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles status\n $ mise bootstrap dotfiles status ~/.zshrc\n $ mise bootstrap dotfiles status --json\n $ mise bootstrap dotfiles status --missing # exit 1 if anything is out of sync\n"}, {Key: FlagDotfilesStatusJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagDotfilesStatusMissing, Short: "Exit with code 1 if any configured dotfiles are not in their desired\nstate (missing, source missing, differs)", Long: "Exit with code 1 if any configured dotfiles are not in their desired\nstate (missing, source missing, differs)"}, {Key: ArgDotfilesStatusTarget, Short: "Only show these targets", Long: "Only show these targets"}, - {Key: CmdDotfilesUnapply, Hide: true, Short: "Remove dotfiles applied from `[dotfiles]`", Long: "Remove dotfiles applied from `[dotfiles]`\n\nRemoves configured whole-file entries and edits while preserving files\nmise cannot identify as managed. Modified copies, templates, and plain-line\nedits require `--force`."}, + {Key: CmdDotfilesUnapply, Hide: true, Short: "Remove dotfiles applied from `[dotfiles]`", Long: "Remove dotfiles applied from `[dotfiles]`\n\nRemoves configured whole-file entries and edits while preserving files\nmise cannot identify as managed. Modified copies, templates, and plain-line\nedits require `--force`.", AfterLongHelp: "Examples:\n\n $ mise bootstrap dotfiles unapply\n $ mise bootstrap dotfiles unapply ~/.zshrc\n $ mise bootstrap dotfiles unapply --dry-run\n $ mise bootstrap dotfiles unapply --force --yes\n"}, {Key: FlagDotfilesUnapplyForce, Short: "Remove modified or otherwise ambiguous managed files and lines", Long: "Remove modified or otherwise ambiguous managed files and lines"}, {Key: FlagDotfilesUnapplyDryRun, Short: "Print the actions that would run without writing anything", Long: "Print the actions that would run without writing anything"}, {Key: FlagDotfilesUnapplyYes, Short: "Skip the confirmation prompt", Long: "Skip the confirmation prompt"}, {Key: ArgDotfilesUnapplyTarget, Short: "Only unapply these targets", Long: "Only unapply these targets"}, - {Key: CmdDoctor, Short: "Check mise installation for possible problems", VisibleAliases: []string{"dr"}}, + {Key: CmdDoctor, Short: "Check mise installation for possible problems", VisibleAliases: []string{"dr"}, AfterLongHelp: "Examples:\n\n $ mise doctor\n [WARN] plugin node is not installed\n"}, {Key: FlagDoctorJson}, - {Key: CmdDoctorPath, Short: "Print the current PATH entries mise is providing"}, + {Key: CmdDoctorPath, Short: "Print the current PATH entries mise is providing", AfterLongHelp: "Examples:\n\n Get the current PATH entries mise is providing\n $ mise doctor path\n /home/user/.local/share/mise/installs/node/24.0.0/bin\n /home/user/.local/share/mise/installs/rust/1.90.0/bin\n /home/user/.local/share/mise/installs/python/3.10.0/bin\n"}, {Key: FlagDoctorPathFull, Short: "Print all entries including those not provided by mise", Long: "Print all entries including those not provided by mise"}, - {Key: CmdEn, Short: "Starts a new shell with the mise environment built from the current configuration", Long: "Starts a new shell with the mise environment built from the current configuration\n\nThis is an alternative to `mise activate` that allows you to explicitly start a mise session.\nIt will have the tools and environment variables in the configs loaded.\nNote that changing directories will not update the mise environment."}, + {Key: CmdEn, Short: "Starts a new shell with the mise environment built from the current configuration", Long: "Starts a new shell with the mise environment built from the current configuration\n\nThis is an alternative to `mise activate` that allows you to explicitly start a mise session.\nIt will have the tools and environment variables in the configs loaded.\nNote that changing directories will not update the mise environment.", AfterLongHelp: "Examples:\n\n $ mise en .\n $ node -v\n v20.0.0\n\n Skip loading bashrc:\n $ mise en -s \"bash --norc\"\n\n Skip loading zshrc:\n $ mise en -s \"zsh -f\"\n"}, {Key: FlagEnShell, ValueName: "SHELL", ValueDemanded: true, Short: "Shell to start", Long: "Shell to start\n\nDefaults to $SHELL"}, {Key: ArgEnDir, Short: "Directory to start the shell in", Long: "Directory to start the shell in", Default: []string{"."}}, - {Key: CmdEnv, Short: "Exports env vars to activate mise a single time", Long: "Exports env vars to activate mise a single time\n\nUse this if you don't want to permanently install mise. It's not necessary to\nuse this if you have `mise activate` in your shell rc file.", VisibleAliases: []string{"e"}}, + {Key: CmdEnv, Short: "Exports env vars to activate mise a single time", Long: "Exports env vars to activate mise a single time\n\nUse this if you don't want to permanently install mise. It's not necessary to\nuse this if you have `mise activate` in your shell rc file.", VisibleAliases: []string{"e"}, AfterLongHelp: "Examples:\n\n $ eval \"$(mise env -s bash)\"\n $ eval \"$(mise env -s zsh)\"\n $ mise env -s fish | source\n $ execx($(mise env -s xonsh))\n"}, {Key: FlagEnvDotenv, Short: "Output in dotenv format", Long: "Output in dotenv format"}, {Key: FlagEnvJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagEnvShell, ValueName: "SHELL", ValueDemanded: true, Short: "Shell type to generate environment variables for", Long: "Shell type to generate environment variables for", Choices: []string{"bash", "elvish", "fish", "nu", "xonsh", "zsh", "pwsh"}}, @@ -5231,7 +5231,7 @@ var HelpText = argv.HelpTable{ {Key: FlagEnvRedacted, Short: "Only show redacted environment variables", Long: "Only show redacted environment variables"}, {Key: FlagEnvValues, Short: "Only show values of environment variables", Long: "Only show values of environment variables"}, {Key: ArgEnvToolVersion, Short: "Tool(s) to use", Long: "Tool(s) to use"}, - {Key: CmdExec, Short: "Execute a command with tool(s) set", Long: "Execute a command with tool(s) set\n\nuse this to avoid modifying the shell session or running ad-hoc commands with mise tools set.\n\nTools will be loaded from mise.toml, though they can be overridden with args\nNote that only the plugin specified will be overridden, so if a `mise.toml` file\nincludes \"node 20\" but you run `mise exec python@3.11`; it will still load node@20.\n\nThe \"--\" separates runtimes from the commands to pass along to the subprocess.", VisibleAliases: []string{"x"}}, + {Key: CmdExec, Short: "Execute a command with tool(s) set", Long: "Execute a command with tool(s) set\n\nuse this to avoid modifying the shell session or running ad-hoc commands with mise tools set.\n\nTools will be loaded from mise.toml, though they can be overridden with args\nNote that only the plugin specified will be overridden, so if a `mise.toml` file\nincludes \"node 20\" but you run `mise exec python@3.11`; it will still load node@20.\n\nThe \"--\" separates runtimes from the commands to pass along to the subprocess.", VisibleAliases: []string{"x"}, AfterLongHelp: "Examples:\n\n $ mise exec node@20 -- node ./app.js # launch app.js using node-20.x\n $ mise x node@20 -- node ./app.js # shorter alias\n\n # Specify command as a string:\n $ mise exec node@20 python@3.11 --command \"node -v && python -V\"\n\n # Run a command in a different directory:\n $ mise x -C /path/to/project node@20 -- node ./app.js\n"}, {Key: FlagExecCommand, ValueName: "C", ValueDemanded: true, Short: "Command string to execute", Long: "Command string to execute"}, {Key: FlagExecJobs, ValueName: "JOBS", ValueDemanded: true, Short: "Number of jobs to run in parallel\n[default: 4]", Long: "Number of jobs to run in parallel\n[default: 4]"}, {Key: FlagExecAllowEnv, Repeatable: true, ValueName: "VAR", ValueDemanded: true, Short: "Allow specific env var through (implies --deny-env for everything else)\nSupports wildcards, e.g. --allow-env='MYAPP_*'", Long: "Allow specific env var through (implies --deny-env for everything else)\nSupports wildcards, e.g. --allow-env='MYAPP_*'"}, @@ -5248,45 +5248,45 @@ var HelpText = argv.HelpTable{ {Key: FlagExecRaw, Short: "Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1", Long: "Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1"}, {Key: ArgExecToolVersion, Short: "Tool(s) to start e.g.: node@20 python@3.10", Long: "Tool(s) to start e.g.: node@20 python@3.10"}, {Key: ArgExecCommand, Short: "Command string to execute (same as --command)", Long: "Command string to execute (same as --command)"}, - {Key: CmdFmt, Short: "Formats mise.toml", Long: "Formats mise.toml\n\nSorts keys and cleans up whitespace in mise.toml"}, + {Key: CmdFmt, Short: "Formats mise.toml", Long: "Formats mise.toml\n\nSorts keys and cleans up whitespace in mise.toml", AfterLongHelp: "Examples:\n\n $ mise fmt\n"}, {Key: FlagFmtAll, Short: "Format all files from the current directory", Long: "Format all files from the current directory"}, {Key: FlagFmtCheck, Short: "Check if the configs are formatted, no formatting is done", Long: "Check if the configs are formatted, no formatting is done"}, {Key: FlagFmtStdin, Short: "Read config from stdin and write its formatted version into stdout", Long: "Read config from stdin and write its formatted version into stdout"}, {Key: CmdGenerate, Short: "Generate files for various tools/services", VisibleAliases: []string{"gen"}}, - {Key: CmdGenerateBootstrap, Short: "Generate a script to download+execute mise", Long: "Generate a script to download+execute mise\n\nThis is designed to be used in a project where contributors may not have mise installed."}, + {Key: CmdGenerateBootstrap, Short: "Generate a script to download+execute mise", Long: "Generate a script to download+execute mise\n\nThis is designed to be used in a project where contributors may not have mise installed.", AfterLongHelp: "Examples:\n\n $ mise generate bootstrap >./bin/mise\n $ chmod +x ./bin/mise\n $ ./bin/mise install – automatically downloads mise to .mise if not already installed\n"}, {Key: FlagGenerateBootstrapLocalize, Short: "Sandboxes mise internal directories like MISE_DATA_DIR and MISE_CACHE_DIR into a `.mise` directory in the project", Long: "Sandboxes mise internal directories like MISE_DATA_DIR and MISE_CACHE_DIR into a `.mise` directory in the project\n\nThis is necessary if users may use a different version of mise outside the project."}, {Key: FlagGenerateBootstrapVersion, ValueName: "VERSION", ValueDemanded: true, Short: "Specify mise version to fetch", Long: "Specify mise version to fetch"}, {Key: FlagGenerateBootstrapWrite, ValueName: "WRITE", ValueDemanded: true, Short: "instead of outputting the script to stdout, write to a file and make it executable", Long: "instead of outputting the script to stdout, write to a file and make it executable"}, {Key: FlagGenerateBootstrapLocalizedDir, ValueName: "LOCALIZED_DIR", ValueDemanded: true, Short: "Directory to put localized data into", Long: "Directory to put localized data into", Default: []string{".mise"}}, - {Key: CmdGenerateConfig, Short: "Generate a mise.toml file"}, + {Key: CmdGenerateConfig, Short: "Generate a mise.toml file", AfterLongHelp: "Examples:\n\n $ mise generate config # generate mise.toml interactively\n $ mise generate config .mise.toml # generate a specific file\n $ mise generate config -g # generate the global config file\n $ mise generate config -y # skip interactive editor\n $ mise generate config -n # preview without writing\n"}, {Key: FlagGenerateConfigGlobal, Short: "Generate the global config file (~/.config/mise/config.toml)", Long: "Generate the global config file (~/.config/mise/config.toml)"}, {Key: FlagGenerateConfigDryRun, Short: "Show what would be generated without writing to file", Long: "Show what would be generated without writing to file"}, {Key: FlagGenerateConfigToolVersions, ValueName: "TOOL_VERSIONS", ValueDemanded: true, Short: "Path to a .tool-versions file to import tools from", Long: "Path to a .tool-versions file to import tools from"}, {Key: ArgGenerateConfigPath, Short: "Path to the config file to create", Long: "Path to the config file to create"}, - {Key: CmdGenerateDevcontainer, Short: "Generate a devcontainer to execute mise"}, + {Key: CmdGenerateDevcontainer, Short: "Generate a devcontainer to execute mise", AfterLongHelp: "Examples:\n\n $ mise generate devcontainer\n"}, {Key: FlagGenerateDevcontainerImage, ValueName: "IMAGE", ValueDemanded: true, Short: "The image to use for the devcontainer", Long: "The image to use for the devcontainer"}, {Key: FlagGenerateDevcontainerMountMiseData, Short: "Bind the mise-data-volume to the devcontainer", Long: "Bind the mise-data-volume to the devcontainer"}, {Key: FlagGenerateDevcontainerName, ValueName: "NAME", ValueDemanded: true, Short: "The name of the devcontainer", Long: "The name of the devcontainer"}, {Key: FlagGenerateDevcontainerWrite, Short: "write to .devcontainer/devcontainer.json", Long: "write to .devcontainer/devcontainer.json"}, - {Key: CmdGenerateGitPreCommit, Short: "Generate a git pre-commit hook", Long: "Generate a git pre-commit hook\n\nThis command generates a git pre-commit hook that runs a mise task like `mise run pre-commit`\nwhen you commit changes to your repository.\n\nStaged files are passed to the task as `STAGED`.\n\nFor more advanced pre-commit functionality, see mise's sister project: https://hk.jdx.dev/", VisibleAliases: []string{"pre-commit"}}, + {Key: CmdGenerateGitPreCommit, Short: "Generate a git pre-commit hook", Long: "Generate a git pre-commit hook\n\nThis command generates a git pre-commit hook that runs a mise task like `mise run pre-commit`\nwhen you commit changes to your repository.\n\nStaged files are passed to the task as `STAGED`.\n\nFor more advanced pre-commit functionality, see mise's sister project: https://hk.jdx.dev/", VisibleAliases: []string{"pre-commit"}, AfterLongHelp: "Examples:\n\n $ mise generate git-pre-commit --write --task=pre-commit\n $ git commit -m \"feat: add new feature\" # runs `mise run pre-commit`\n"}, {Key: FlagGenerateGitPreCommitTask, ValueName: "TASK", ValueDemanded: true, Short: "The task to run when the pre-commit hook is triggered", Long: "The task to run when the pre-commit hook is triggered", Default: []string{"pre-commit"}}, {Key: FlagGenerateGitPreCommitWrite, Short: "write to .git/hooks/pre-commit and make it executable", Long: "write to .git/hooks/pre-commit and make it executable"}, {Key: FlagGenerateGitPreCommitHook, ValueName: "HOOK", ValueDemanded: true, Short: "Which hook to generate (saves to .git/hooks/$hook)", Long: "Which hook to generate (saves to .git/hooks/$hook)", Default: []string{"pre-commit"}}, - {Key: CmdGenerateGithubAction, Short: "Generate a GitHub Action workflow file", Long: "Generate a GitHub Action workflow file\n\nThis command generates a GitHub Action workflow file that runs a mise task like `mise run ci`\nwhen you push changes to your repository."}, + {Key: CmdGenerateGithubAction, Short: "Generate a GitHub Action workflow file", Long: "Generate a GitHub Action workflow file\n\nThis command generates a GitHub Action workflow file that runs a mise task like `mise run ci`\nwhen you push changes to your repository.", AfterLongHelp: "Examples:\n\n $ mise generate github-action --write --task=ci\n $ git commit -m \"feat: add new feature\"\n $ git push # runs `mise run ci` on GitHub\n"}, {Key: FlagGenerateGithubActionTask, ValueName: "TASK", ValueDemanded: true, Short: "The task to run when the workflow is triggered", Long: "The task to run when the workflow is triggered", Default: []string{"ci"}}, {Key: FlagGenerateGithubActionWrite, Short: "write to .github/workflows/$name.yml", Long: "write to .github/workflows/$name.yml"}, {Key: FlagGenerateGithubActionName, ValueName: "NAME", ValueDemanded: true, Short: "the name of the workflow to generate", Long: "the name of the workflow to generate", Default: []string{"ci"}}, - {Key: CmdGenerateTaskDocs, Short: "Generate documentation for tasks in a project"}, + {Key: CmdGenerateTaskDocs, Short: "Generate documentation for tasks in a project", AfterLongHelp: "Examples:\n\n $ mise generate task-docs\n"}, {Key: FlagGenerateTaskDocsInject, Short: "inserts the documentation into an existing file", Long: "inserts the documentation into an existing file\n\nThis will look for a special comment, ``, and replace it with the generated documentation.\nIt will replace everything between the comment and the next comment, `` so it can be\nrun multiple times on the same file to update the documentation.\nThe file must already contain both comments; mise errors instead of modifying the file if they are missing."}, {Key: FlagGenerateTaskDocsIndex, Short: "write only an index of tasks, intended for use with `--multi`", Long: "write only an index of tasks, intended for use with `--multi`"}, {Key: FlagGenerateTaskDocsMulti, Short: "render each task as a separate document, requires `--output` to be a directory", Long: "render each task as a separate document, requires `--output` to be a directory"}, {Key: FlagGenerateTaskDocsOutput, ValueName: "OUTPUT", ValueDemanded: true, Short: "writes the generated docs to a file/directory", Long: "writes the generated docs to a file/directory"}, {Key: FlagGenerateTaskDocsRoot, ValueName: "ROOT", ValueDemanded: true, Short: "root directory to search for tasks", Long: "root directory to search for tasks"}, {Key: FlagGenerateTaskDocsStyle, ValueName: "STYLE", ValueDemanded: true, Choices: []string{"simple", "detailed"}, Default: []string{"simple"}}, - {Key: CmdGenerateTaskStubs, Short: "Generates shims to run mise tasks", Long: "Generates shims to run mise tasks\n\nBy default, this will build shims like ./bin/. These can be paired with `mise generate bootstrap`\nso contributors to a project can execute mise tasks without installing mise into their system."}, + {Key: CmdGenerateTaskStubs, Short: "Generates shims to run mise tasks", Long: "Generates shims to run mise tasks\n\nBy default, this will build shims like ./bin/. These can be paired with `mise generate bootstrap`\nso contributors to a project can execute mise tasks without installing mise into their system.", AfterLongHelp: "Examples:\n\n $ mise tasks add test -- echo 'running tests'\n $ mise generate task-stubs\n $ ./bin/test\n running tests\n"}, {Key: FlagGenerateTaskStubsDir, ValueName: "DIR", ValueDemanded: true, Short: "Directory to create task stubs inside of", Long: "Directory to create task stubs inside of", Default: []string{"bin"}}, {Key: FlagGenerateTaskStubsMiseBin, ValueName: "MISE_BIN", ValueDemanded: true, Short: "Path to a mise bin to use when running the task stub.", Long: "Path to a mise bin to use when running the task stub.\n\nUse `--mise-bin=./bin/mise` to use a mise bin generated from `mise generate bootstrap`", Default: []string{"mise"}}, - {Key: CmdGenerateToolStub, Short: "Generate a tool stub for HTTP-based tools", Long: "Generate a tool stub for HTTP-based tools\n\nThis command generates tool stubs that can automatically download and execute\ntools from HTTP URLs. It can detect checksums, file sizes, and binary paths\nautomatically by downloading and analyzing the tool.\n\nWhen generating stubs with platform-specific URLs, the command will append new\nplatforms to existing stub files rather than overwriting them. This allows you\nto incrementally build cross-platform tool stubs."}, + {Key: CmdGenerateToolStub, Short: "Generate a tool stub for HTTP-based tools", Long: "Generate a tool stub for HTTP-based tools\n\nThis command generates tool stubs that can automatically download and execute\ntools from HTTP URLs. It can detect checksums, file sizes, and binary paths\nautomatically by downloading and analyzing the tool.\n\nWhen generating stubs with platform-specific URLs, the command will append new\nplatforms to existing stub files rather than overwriting them. This allows you\nto incrementally build cross-platform tool stubs.", AfterLongHelp: "Examples:\n\n Generate a tool stub for a single URL:\n $ mise generate tool-stub ./bin/gh --url \"https://github.com/cli/cli/releases/download/v2.96.0/gh_2.96.0_linux_amd64.tar.gz\"\n\n Generate a tool stub with platform-specific URLs:\n $ mise generate tool-stub ./bin/rg \\\n --platform-url linux-x64:https://github.com/BurntSushi/ripgrep/releases/download/14.0.3/ripgrep-14.0.3-x86_64-unknown-linux-musl.tar.gz \\\n --platform-url darwin-arm64:https://github.com/BurntSushi/ripgrep/releases/download/14.0.3/ripgrep-14.0.3-aarch64-apple-darwin.tar.gz\n\n Append additional platforms to an existing stub:\n $ mise generate tool-stub ./bin/rg \\\n --platform-url linux-x64:https://example.com/rg-linux.tar.gz\n $ mise generate tool-stub ./bin/rg \\\n --platform-url darwin-arm64:https://example.com/rg-darwin.tar.gz\n # The stub now contains both platforms\n\n Use auto-detection for platform from URL:\n $ mise generate tool-stub ./bin/node \\\n --platform-url https://nodejs.org/dist/v22.17.1/node-v22.17.1-darwin-arm64.tar.gz\n # Platform 'macos-arm64' will be auto-detected from the URL\n\n Generate with platform-specific binary paths:\n $ mise generate tool-stub ./bin/tool \\\n --platform-url linux-x64:https://example.com/tool-linux.tar.gz \\\n --platform-url windows-x64:https://example.com/tool-windows.zip \\\n --platform-bin windows-x64:tool.exe\n\n Generate without downloading (faster):\n $ mise generate tool-stub ./bin/tool --url \"https://example.com/tool.tar.gz\" --skip-download\n\n Fetch checksums for an existing stub:\n $ mise generate tool-stub ./bin/jq --fetch\n # This will read the existing stub and download files to fill in any missing checksums/sizes\n\n Generate a bootstrap stub that installs mise if needed:\n $ mise generate tool-stub ./bin/tool --url \"https://example.com/tool.tar.gz\" --bootstrap\n # The stub will check for mise and install it automatically before running the tool\n\n Generate a bootstrap stub with a pinned mise version:\n $ mise generate tool-stub ./bin/tool --url \"https://example.com/tool.tar.gz\" --bootstrap --bootstrap-version 2025.1.0\n\n Lock an existing tool stub with pinned version and platform URLs/checksums:\n $ mise generate tool-stub ./bin/node --lock\n\n Bump the version in a locked stub:\n $ mise generate tool-stub ./bin/node --lock --version 22\n # Resolves the latest node 22.x, pins it, and updates platform URLs/checksums\n"}, {Key: FlagGenerateToolStubBin, ValueName: "BIN", ValueDemanded: true, Short: "Binary path within the extracted archive", Long: "Binary path within the extracted archive\n\nIf not specified and the archive is downloaded, will auto-detect the most likely binary"}, {Key: FlagGenerateToolStubBootstrap, Short: "Wrap stub in a bootstrap script that installs mise if not already present", Long: "Wrap stub in a bootstrap script that installs mise if not already present\n\nWhen enabled, generates a bash script that:\n1. Checks if mise is installed at the expected path\n2. If not, downloads and installs mise using the embedded installer\n3. Executes the tool stub using mise"}, {Key: FlagGenerateToolStubBootstrapVersion, ValueName: "BOOTSTRAP_VERSION", ValueDemanded: true, Short: "Specify mise version for the bootstrap script", Long: "Specify mise version for the bootstrap script\n\nBy default, uses the latest version from the install script.\nUse this to pin to a specific version (e.g., \"2025.1.0\")."}, @@ -5300,13 +5300,13 @@ var HelpText = argv.HelpTable{ {Key: FlagGenerateToolStubVersion, ValueName: "VERSION", ValueDemanded: true, Short: "Version of the tool", Long: "Version of the tool", Default: []string{"latest"}}, {Key: ArgGenerateToolStubOutput, Demanded: true, Short: "Output file path for the tool stub", Long: "Output file path for the tool stub"}, {Key: CmdGithub, Hide: true, Short: "GitHub related commands"}, - {Key: CmdGithubToken, Hide: true, Short: "Display the GitHub token mise will use for a given host", Long: "Display the GitHub token mise will use for a given host\n\nShows which token source mise would use, useful for debugging\nauthentication issues. The token is masked by default."}, + {Key: CmdGithubToken, Hide: true, Short: "Display the GitHub token mise will use for a given host", Long: "Display the GitHub token mise will use for a given host\n\nShows which token source mise would use, useful for debugging\nauthentication issues. The token is masked by default.", AfterLongHelp: "Examples:\n\n $ mise github token\n github.com: ghp_…xxxx (source: GITHUB_TOKEN)\n\n $ mise github token --unmask\n github.com: ghp_xxxxxxxxxxxx (source: GITHUB_TOKEN)\n\n $ mise github token github.mycompany.com\n github.mycompany.com: (none)\n"}, {Key: FlagGithubTokenOauth, Short: "Force native GitHub OAuth device flow instead of normal token resolution", Long: "Force native GitHub OAuth device flow instead of normal token resolution"}, {Key: FlagGithubTokenRaw, Short: "Print only the token value", Long: "Print only the token value"}, {Key: FlagGithubTokenRefresh, Short: "Mint a fresh OAuth token even if the cached one has not expired, via the refresh-token grant or a new device-code flow", Long: "Mint a fresh OAuth token even if the cached one has not expired, via the refresh-token grant or a new device-code flow"}, {Key: FlagGithubTokenUnmask, Short: "Show the full unmasked token", Long: "Show the full unmasked token"}, {Key: ArgGithubTokenHost, Short: "GitHub hostname", Long: "GitHub hostname", Default: []string{"github.com"}}, - {Key: CmdGlobal, Hide: true, Short: "Sets/gets the global tool version(s)", Long: "Sets/gets the global tool version(s)\n\nDisplays the contents of global config after writing.\nThe file is `$HOME/.config/mise/config.toml` by default. It can be changed with `$MISE_GLOBAL_CONFIG_FILE`.\nIf `$MISE_GLOBAL_CONFIG_FILE` is set to anything that ends in `.toml`, it will be parsed as `mise.toml`.\nOtherwise, it will be parsed as a `.tool-versions` file.\n\nUse MISE_ASDF_COMPAT=1 to default the global config to ~/.tool-versions\n\nUse `mise local` to set a tool version locally in the current directory."}, + {Key: CmdGlobal, Hide: true, Short: "Sets/gets the global tool version(s)", Long: "Sets/gets the global tool version(s)\n\nDisplays the contents of global config after writing.\nThe file is `$HOME/.config/mise/config.toml` by default. It can be changed with `$MISE_GLOBAL_CONFIG_FILE`.\nIf `$MISE_GLOBAL_CONFIG_FILE` is set to anything that ends in `.toml`, it will be parsed as `mise.toml`.\nOtherwise, it will be parsed as a `.tool-versions` file.\n\nUse MISE_ASDF_COMPAT=1 to default the global config to ~/.tool-versions\n\nUse `mise local` to set a tool version locally in the current directory.", AfterLongHelp: "Examples:\n # set the current version of node to 20.x\n # will use a fuzzy version (e.g.: 20) in .tool-versions file\n $ mise global --fuzzy node@20\n\n # set the current version of node to 20.x\n # will use a precise version (e.g.: 20.0.0) in .tool-versions file\n $ mise global --pin node@20\n\n # show the current version of node in ~/.tool-versions\n $ mise global node\n 20.0.0\n"}, {Key: FlagGlobalFuzzy, Short: "Save fuzzy version to `~/.tool-versions`\ne.g.: `mise global --fuzzy node@20` will save `node 20` to ~/.tool-versions\nthis is the default behavior unless MISE_ASDF_COMPAT=1", Long: "Save fuzzy version to `~/.tool-versions`\ne.g.: `mise global --fuzzy node@20` will save `node 20` to ~/.tool-versions\nthis is the default behavior unless MISE_ASDF_COMPAT=1"}, {Key: FlagGlobalPath, Short: "Get the path of the global config file", Long: "Get the path of the global config file"}, {Key: FlagGlobalPin, Short: "Save exact version to `~/.tool-versions`\ne.g.: `mise global --pin node@20` will save `node 20.0.0` to ~/.tool-versions", Long: "Save exact version to `~/.tool-versions`\ne.g.: `mise global --pin node@20` will save `node 20.0.0` to ~/.tool-versions"}, @@ -5324,12 +5324,12 @@ var HelpText = argv.HelpTable{ {Key: CmdImplode, Short: "Removes mise CLI and all related data", Long: "Removes mise CLI and all related data\n\nSkips config directory by default."}, {Key: FlagImplodeDryRun, Short: "List directories that would be removed without actually removing them", Long: "List directories that would be removed without actually removing them"}, {Key: FlagImplodeConfig, Short: "Also remove config directory", Long: "Also remove config directory"}, - {Key: CmdEdit, Short: "Edit mise.toml interactively"}, + {Key: CmdEdit, Short: "Edit mise.toml interactively", AfterLongHelp: "Examples:\n\n $ mise edit # edit mise.toml interactively\n $ mise edit .mise.toml # edit a specific file\n $ mise edit -g # edit the global config file\n $ mise edit -y # skip interactive editor\n $ mise edit -n # preview without writing\n"}, {Key: FlagEditGlobal, Short: "Edit the global config file (~/.config/mise/config.toml)", Long: "Edit the global config file (~/.config/mise/config.toml)"}, {Key: FlagEditDryRun, Short: "Show what would be generated without writing to file", Long: "Show what would be generated without writing to file"}, {Key: FlagEditToolVersions, ValueName: "TOOL_VERSIONS", ValueDemanded: true, Short: "Path to a .tool-versions file to import tools from", Long: "Path to a .tool-versions file to import tools from"}, {Key: ArgEditPath, Short: "Path to the config file to create", Long: "Path to the config file to create"}, - {Key: CmdInstall, Short: "Install a tool version", Long: "Install a tool version\n\nInstalls a tool version to `~/.local/share/mise/installs//`\nInstalling alone will not activate the tools so they won't be in PATH.\nTo install and/or activate in one command, use `mise use` which will create a `mise.toml` file\nin the current directory to activate this tool when inside the directory.\nAlternatively, run `mise exec @ -- ` to execute a tool without creating config files.\n\nTools will be installed in parallel. To disable, set `--jobs=1` or `MISE_JOBS=1`", VisibleAliases: []string{"i"}}, + {Key: CmdInstall, Short: "Install a tool version", Long: "Install a tool version\n\nInstalls a tool version to `~/.local/share/mise/installs//`\nInstalling alone will not activate the tools so they won't be in PATH.\nTo install and/or activate in one command, use `mise use` which will create a `mise.toml` file\nin the current directory to activate this tool when inside the directory.\nAlternatively, run `mise exec @ -- ` to execute a tool without creating config files.\n\nTools will be installed in parallel. To disable, set `--jobs=1` or `MISE_JOBS=1`", VisibleAliases: []string{"i"}, AfterLongHelp: "Examples:\n\n $ mise install node@20.0.0 # install specific node version\n $ mise install node@20 # install fuzzy node version\n $ mise install node # install version specified in mise.toml\n $ mise install # installs everything specified in mise.toml\n"}, {Key: FlagInstallForce, Short: "Force reinstall even if already installed", Long: "Force reinstall even if already installed"}, {Key: FlagInstallJobs, ValueName: "JOBS", ValueDemanded: true, Short: "Number of jobs to run in parallel\n[default: 4]", Long: "Number of jobs to run in parallel\n[default: 4]"}, {Key: FlagInstallDryRun, Short: "Show what would be installed without actually installing", Long: "Show what would be installed without actually installing"}, @@ -5341,26 +5341,26 @@ var HelpText = argv.HelpTable{ {Key: FlagInstallShared, ValueName: "SHARED", ValueDemanded: true, Short: "Install tool(s) to a shared directory", Long: "Install tool(s) to a shared directory\n\nInstalls to the specified directory instead of the default install location.\nMay require elevated permissions depending on the path."}, {Key: FlagInstallSystem, Short: "Install tool(s) to the system-wide shared directory", Long: "Install tool(s) to the system-wide shared directory\n\nInstalls to /usr/local/share/mise/installs (or MISE_SYSTEM_DATA_DIR/installs).\nMay require elevated permissions (e.g. sudo)."}, {Key: ArgInstallToolVersion, Short: "Tool(s) to install e.g.: node@20", Long: "Tool(s) to install e.g.: node@20"}, - {Key: CmdInstallInto, Short: "Install a tool version to a specific path", Long: "Install a tool version to a specific path\n\nUsed for building a tool to a directory for use outside of mise"}, + {Key: CmdInstallInto, Short: "Install a tool version to a specific path", Long: "Install a tool version to a specific path\n\nUsed for building a tool to a directory for use outside of mise", AfterLongHelp: "Examples:\n\n # install node@20.0.0 into ./mynode\n $ mise install-into node@20.0.0 ./mynode && ./mynode/bin/node -v\n 20.0.0\n"}, {Key: ArgInstallIntoToolVersion, Demanded: true, Short: "Tool to install e.g.: node@20", Long: "Tool to install e.g.: node@20"}, {Key: ArgInstallIntoPath, Demanded: true, Short: "Path to install the tool into", Long: "Path to install the tool into"}, - {Key: CmdLatest, Short: "Gets the latest available version for a plugin", Long: "Gets the latest available version for a plugin\n\nSupports prefixes such as `node@20` to get the latest version of node 20."}, + {Key: CmdLatest, Short: "Gets the latest available version for a plugin", Long: "Gets the latest available version for a plugin\n\nSupports prefixes such as `node@20` to get the latest version of node 20.", AfterLongHelp: "Examples:\n\n $ mise latest node@20 # get the latest version of node 20\n 20.0.0\n\n $ mise latest node # get the latest stable version of node\n 20.0.0\n\n $ mise latest node --minimum-release-age 2024-01-01 # latest stable node released before 2024-01-01\n"}, {Key: FlagLatestInstalled, Short: "Show latest installed instead of available version", Long: "Show latest installed instead of available version"}, {Key: FlagLatestMinimumReleaseAge, ValueName: "MINIMUM_RELEASE_AGE", ValueDemanded: true, Short: "Only consider versions released before this date or older than this duration", Long: "Only consider versions released before this date or older than this duration\n\nSupports absolute dates like \"2024-06-01\" and relative durations like \"90d\" or \"1y\".\nOverrides per-tool `minimum_release_age` options and the global `minimum_release_age` setting."}, {Key: ArgLatestToolVersion, Demanded: true, Short: "Tool to get the latest version of", Long: "Tool to get the latest version of"}, {Key: ArgLatestAsdfVersion, Hide: true, Short: "The version prefix to use when querying the latest version same as the first argument after the \"@\" used for asdf compatibility", Long: "The version prefix to use when querying the latest version same as the first argument after the \"@\" used for asdf compatibility"}, - {Key: CmdLink, Short: "Symlinks a tool version into mise", Long: "Symlinks a tool version into mise\n\nUse this for adding installs either custom compiled outside mise or built with a different tool.", VisibleAliases: []string{"ln"}}, + {Key: CmdLink, Short: "Symlinks a tool version into mise", Long: "Symlinks a tool version into mise\n\nUse this for adding installs either custom compiled outside mise or built with a different tool.", VisibleAliases: []string{"ln"}, AfterLongHelp: "Examples:\n\n # build node-20.0.0 with node-build and link it into mise\n $ node-build 20.0.0 ~/.nodes/20.0.0\n $ mise link node@20.0.0 ~/.nodes/20.0.0\n\n # have mise use the node version provided by Homebrew\n $ brew install node\n $ mise link node@brew $(brew --prefix node)\n $ mise use node@brew\n"}, {Key: FlagLinkForce, Short: "Overwrite an existing tool version if it exists", Long: "Overwrite an existing tool version if it exists"}, {Key: ArgLinkToolVersion, Demanded: true, Short: "Tool name and version to create a symlink for", Long: "Tool name and version to create a symlink for"}, {Key: ArgLinkPath, Demanded: true, Short: "The local path to the tool version\ne.g.: ~/.nvm/versions/node/v20.0.0", Long: "The local path to the tool version\ne.g.: ~/.nvm/versions/node/v20.0.0"}, - {Key: CmdLocal, Hide: true, Short: "Sets/gets tool version in local .tool-versions or mise.toml", Long: "Sets/gets tool version in local .tool-versions or mise.toml\n\nUse this to set a tool's version when within a directory\nUse `mise global` to set a tool version globally\nThis uses `.tool-version` by default unless there is a `mise.toml` file or if `MISE_USE_TOML`\nis set. A future v2 release of mise will default to using `mise.toml`."}, + {Key: CmdLocal, Hide: true, Short: "Sets/gets tool version in local .tool-versions or mise.toml", Long: "Sets/gets tool version in local .tool-versions or mise.toml\n\nUse this to set a tool's version when within a directory\nUse `mise global` to set a tool version globally\nThis uses `.tool-version` by default unless there is a `mise.toml` file or if `MISE_USE_TOML`\nis set. A future v2 release of mise will default to using `mise.toml`.", AfterLongHelp: "Examples:\n # set the current version of node to 20.x for the current directory\n # will use a precise version (e.g.: 20.0.0) in .tool-versions file\n $ mise local node@20\n\n # set node to 20.x for the current project (recurses up to find .tool-versions)\n $ mise local -p node@20\n\n # set the current version of node to 20.x for the current directory\n # will use a fuzzy version (e.g.: 20) in .tool-versions file\n $ mise local --fuzzy node@20\n\n # removes node from .tool-versions\n $ mise local --remove=node\n\n # show the current version of node in .tool-versions\n $ mise local node\n 20.0.0\n"}, {Key: FlagLocalParent, Short: "Recurse up to find a .tool-versions file rather than using the current directory only\nby default this command will only set the tool in the current directory (\"$PWD/.tool-versions\")", Long: "Recurse up to find a .tool-versions file rather than using the current directory only\nby default this command will only set the tool in the current directory (\"$PWD/.tool-versions\")"}, {Key: FlagLocalFuzzy, Short: "Save fuzzy version to `.tool-versions` e.g.: `mise local --fuzzy node@20` will save `node 20` to .tool-versions This is the default behavior unless MISE_ASDF_COMPAT=1", Long: "Save fuzzy version to `.tool-versions` e.g.: `mise local --fuzzy node@20` will save `node 20` to .tool-versions This is the default behavior unless MISE_ASDF_COMPAT=1"}, {Key: FlagLocalPath, Short: "Get the path of the config file", Long: "Get the path of the config file"}, {Key: FlagLocalPin, Short: "Save exact version to `.tool-versions`\ne.g.: `mise local --pin node@20` will save `node 20.0.0` to .tool-versions", Long: "Save exact version to `.tool-versions`\ne.g.: `mise local --pin node@20` will save `node 20.0.0` to .tool-versions"}, {Key: FlagLocalRemove, Repeatable: true, ValueName: "TOOL", ValueDemanded: true, Short: "Remove the tool(s) from .tool-versions", Long: "Remove the tool(s) from .tool-versions"}, {Key: ArgLocalToolVersion, Short: "Tool(s) to add to .tool-versions/mise.toml\ne.g.: node@20\nif this is a single tool with no version,\nthe current value of .tool-versions/mise.toml will be displayed", Long: "Tool(s) to add to .tool-versions/mise.toml\ne.g.: node@20\nif this is a single tool with no version,\nthe current value of .tool-versions/mise.toml will be displayed"}, - {Key: CmdLock, Short: "Update lockfile checksums and URLs for all specified platforms", Long: "Update lockfile checksums and URLs for all specified platforms\n\nUpdates checksums and download URLs for all platforms already specified in the lockfile.\nIf no lockfile exists, shows what would be created based on the current configuration.\nThis allows you to refresh lockfile data for platforms other than the one you're currently on.\nOperates on the lockfile in the current config root. Use TOOL arguments to target specific tools."}, + {Key: CmdLock, Short: "Update lockfile checksums and URLs for all specified platforms", Long: "Update lockfile checksums and URLs for all specified platforms\n\nUpdates checksums and download URLs for all platforms already specified in the lockfile.\nIf no lockfile exists, shows what would be created based on the current configuration.\nThis allows you to refresh lockfile data for platforms other than the one you're currently on.\nOperates on the lockfile in the current config root. Use TOOL arguments to target specific tools.", AfterLongHelp: "Examples:\n\n $ mise lock # update lockfile for all common platforms\n $ mise lock node python # update only node and python\n $ mise lock --platform linux-x64 # update only linux-x64 platform\n $ mise lock --dry-run # show what would be updated\n $ mise lock --bump # re-resolve selectors like \"latest\" or \"20\" to the latest matching versions\n $ mise lock --bump --dry-run --json # list available updates as JSON without writing\n $ mise lock --minimum-release-age 2024-01-01 # lock latest/fuzzy versions released before 2024-01-01\n $ mise lock --local # update mise.local.lock for local configs\n $ mise lock --global # update only global config lockfiles\n"}, {Key: FlagLockGlobal, Short: "Target only global config lockfiles (~/.config/mise/mise.lock and system config)\nBy default, only the active project config root is locked", Long: "Target only global config lockfiles (~/.config/mise/mise.lock and system config)\nBy default, only the active project config root is locked"}, {Key: FlagLockJobs, ValueName: "JOBS", ValueDemanded: true, Short: "Number of jobs to run in parallel", Long: "Number of jobs to run in parallel"}, {Key: FlagLockDryRun, Short: "Show what would be updated without making changes", Long: "Show what would be updated without making changes"}, @@ -5370,7 +5370,7 @@ var HelpText = argv.HelpTable{ {Key: FlagLockLocal, Short: "Update mise.local.lock instead of mise.lock\nUse for tools defined in .local.toml configs", Long: "Update mise.local.lock instead of mise.lock\nUse for tools defined in .local.toml configs"}, {Key: FlagLockMinimumReleaseAge, ValueName: "MINIMUM_RELEASE_AGE", ValueDemanded: true, Short: "Only lock versions released before this age or date", Long: "Only lock versions released before this age or date\n\nSupports absolute dates like \"2024-06-01\" and relative durations like \"90d\" or \"1y\".\nThis only affects fuzzy version matches like \"20\" or \"latest\".\nExplicitly pinned versions like \"22.5.0\" are not filtered.\nExisting matching lockfile entries are preserved and are not downgraded solely by this flag."}, {Key: ArgLockTool, Short: "Tool(s) to update in lockfile\ne.g.: node python\nIf not specified, all tools in lockfile will be updated", Long: "Tool(s) to update in lockfile\ne.g.: node python\nIf not specified, all tools in lockfile will be updated"}, - {Key: CmdLs, Short: "List installed and active tool versions", Long: "List installed and active tool versions\n\nThis command lists tools that mise \"knows about\".\nThese may be tools that are currently installed, or those\nthat are in a config file (active) but may or may not be installed.\n\nIt's a useful command to get the current state of your tools.", VisibleAliases: []string{"list"}}, + {Key: CmdLs, Short: "List installed and active tool versions", Long: "List installed and active tool versions\n\nThis command lists tools that mise \"knows about\".\nThese may be tools that are currently installed, or those\nthat are in a config file (active) but may or may not be installed.\n\nIt's a useful command to get the current state of your tools.", VisibleAliases: []string{"list"}, AfterLongHelp: "Examples:\n\n $ mise ls\n node 20.0.0 ~/src/myapp/.tool-versions latest\n python 3.11.0 ~/.tool-versions 3.10\n python 3.10.0\n\n $ mise ls --current\n node 20.0.0 ~/src/myapp/.tool-versions 20\n python 3.11.0 ~/.tool-versions 3.11.0\n\n $ mise ls --json\n {\n \"node\": [\n {\n \"version\": \"20.0.0\",\n \"install_path\": \"/Users/jdx/.mise/installs/node/20.0.0\",\n \"source\": {\n \"type\": \"mise.toml\",\n \"path\": \"/Users/jdx/mise.toml\"\n }\n }\n ],\n \"python\": [...]\n }\n\n $ mise ls --all-sources\n node 20.0.0 ~/src/myapp/mise.toml 20\n ~/.config/mise/config.toml latest\n"}, {Key: FlagLsCurrent, Short: "Only show tool versions currently specified in a mise.toml", Long: "Only show tool versions currently specified in a mise.toml"}, {Key: FlagLsGlobal, Short: "Only show tool versions currently specified in the global mise.toml", Long: "Only show tool versions currently specified in the global mise.toml"}, {Key: FlagLsInstalled, Short: "Only show tool versions that are installed (Hides tools defined in mise.toml but not installed)", Long: "Only show tool versions that are installed (Hides tools defined in mise.toml but not installed)"}, @@ -5386,7 +5386,7 @@ var HelpText = argv.HelpTable{ {Key: FlagLsPrefix, ValueName: "PREFIX", ValueDemanded: true, Short: "Display versions matching this prefix", Long: "Display versions matching this prefix"}, {Key: FlagLsPrunable, Short: "List only tools that can be pruned with `mise prune`", Long: "List only tools that can be pruned with `mise prune`"}, {Key: ArgLsInstalledTool, Short: "Only show tool versions from [TOOL]", Long: "Only show tool versions from [TOOL]"}, - {Key: CmdLsRemote, Short: "List runtime versions available for install.", Long: "List runtime versions available for install.\n\nNote that the results may be cached, run `mise cache clean` to clear the cache and get fresh results."}, + {Key: CmdLsRemote, Short: "List runtime versions available for install.", Long: "List runtime versions available for install.\n\nNote that the results may be cached, run `mise cache clean` to clear the cache and get fresh results.", AfterLongHelp: "Examples:\n\n $ mise ls-remote node\n 18.0.0\n 20.0.0\n\n $ mise ls-remote node@20\n 20.0.0\n 20.1.0\n\n $ mise ls-remote node 20\n 20.0.0\n 20.1.0\n\n $ mise ls-remote node --minimum-release-age 2024-01-01\n 20.0.0\n\n $ mise ls-remote github:cli/cli --json\n [{\"version\":\"2.62.0\",\"created_at\":\"2024-11-14T15:40:35Z\",\"prerelease\":false},{\"version\":\"2.61.0\",\"created_at\":\"2024-10-23T19:22:15Z\",\"prerelease\":false}]\n"}, {Key: FlagLsRemoteAll, Short: "Show all installed plugins and versions", Long: "Show all installed plugins and versions"}, {Key: FlagLsRemoteMinimumReleaseAge, ValueName: "MINIMUM_RELEASE_AGE", ValueDemanded: true, Short: "Only show versions released before this age or date", Long: "Only show versions released before this age or date\n\nSupports absolute dates like \"2024-06-01\" and relative durations like \"90d\" or \"1y\"."}, {Key: FlagLsRemoteJson, Short: "Output in JSON format (includes version metadata like created_at timestamps when available)", Long: "Output in JSON format (includes version metadata like created_at timestamps when available)"}, @@ -5395,9 +5395,9 @@ var HelpText = argv.HelpTable{ {Key: FlagLsRemoteStrictMetadata, Short: "Fail if release metadata fetches fail", Long: "Fail if release metadata fetches fail\n\nRequires --json and --no-versions-host.\n\nThis prevents metadata consumers from accepting empty fallback results\nwhen a backend's metadata-producing upstream request fails."}, {Key: ArgLsRemoteToolVersion, Short: "Tool to get versions for", Long: "Tool to get versions for"}, {Key: ArgLsRemotePrefix, Short: "The version prefix to use when querying the latest version\nsame as the first argument after the \"@\"", Long: "The version prefix to use when querying the latest version\nsame as the first argument after the \"@\""}, - {Key: CmdMcp, Short: "Run Model Context Protocol (MCP) server", Long: "Run Model Context Protocol (MCP) server\n\nThis command starts an MCP server that exposes mise functionality\nto AI assistants over stdin/stdout using JSON-RPC protocol.\n\nThe MCP server provides access to:\n- Installed and available tools\n- Task definitions and execution\n- Environment variables\n- Configuration information\n- Task execution via the run_task tool\n\nResources available:\n- mise://tools - List all tools (use ?include_inactive=true to include inactive tools)\n- mise://tasks - List all tasks with their configurations\n- mise://env - List all environment variables\n- mise://config - Show configuration files and project root\n\nTools available:\n- list_commands - Every mise command, with its declared effect on the world\n- install_tool - Install a tool with an optional version (not yet implemented)\n- run_task - Execute a mise task with optional arguments\n\nNote: This is primarily intended for integration with AI assistants like Claude,\nCursor, or other tools that support the Model Context Protocol."}, + {Key: CmdMcp, Short: "Run Model Context Protocol (MCP) server", Long: "Run Model Context Protocol (MCP) server\n\nThis command starts an MCP server that exposes mise functionality\nto AI assistants over stdin/stdout using JSON-RPC protocol.\n\nThe MCP server provides access to:\n- Installed and available tools\n- Task definitions and execution\n- Environment variables\n- Configuration information\n- Task execution via the run_task tool\n\nResources available:\n- mise://tools - List all tools (use ?include_inactive=true to include inactive tools)\n- mise://tasks - List all tasks with their configurations\n- mise://env - List all environment variables\n- mise://config - Show configuration files and project root\n\nTools available:\n- list_commands - Every mise command, with its declared effect on the world\n- install_tool - Install a tool with an optional version (not yet implemented)\n- run_task - Execute a mise task with optional arguments\n\nNote: This is primarily intended for integration with AI assistants like Claude,\nCursor, or other tools that support the Model Context Protocol.", AfterLongHelp: "Examples:\n\n # Start the MCP server (typically used by AI assistant tools)\n $ mise mcp\n\n # Example integration with Claude Desktop (add to claude_desktop_config.json):\n {\n \"mcpServers\": {\n \"mise\": {\n \"command\": \"mise\",\n \"args\": [\"mcp\"],\n \"env\": {}\n }\n }\n }\n\n # Interactive testing with JSON-RPC commands:\n $ echo '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"protocolVersion\":\"2024-11-05\",\"capabilities\":{},\"clientInfo\":{\"name\":\"test\",\"version\":\"1.0\"}}}' | mise mcp\n\n # Resources you can query:\n - mise://tools - List active tools\n - mise://tools?include_inactive=true - List all installed tools\n - mise://tasks - List all tasks\n - mise://env - List environment variables\n - mise://config - Show configuration info\n\n # Tools available:\n - list_commands - Every mise command and what running it does\n Example: {\"include_hidden\": false}\n - install_tool - Install a tool (not yet implemented)\n - run_task - Execute a mise task with optional arguments\n Example: {\"task\": \"build\", \"args\": [\"--verbose\"]}\n"}, {Key: CmdOci, Short: "[experimental] Build OCI container images from a mise.toml", Long: "[experimental] Build OCI container images from a mise.toml\n\nEach tool becomes its own OCI layer, so bumping any single tool version\nonly invalidates one content-addressable blob — unlike a Dockerfile where\nchanging an early `RUN` invalidates every layer above it.\n\nThis command is experimental and requires `mise settings experimental=true`\n(or `MISE_EXPERIMENTAL=1`). Behavior, flags, and output layout may change\nin future releases."}, - {Key: CmdOciBuild, Short: "[experimental] Build an OCI image from the current mise.toml", Long: "[experimental] Build an OCI image from the current mise.toml\n\nEach tool version becomes its own content-addressable OCI layer. Bumping a\ntool version only invalidates that tool's layer — other tools, the base\nimage, and config are reused unchanged. The output directory conforms to\nthe OCI image-layout spec and can be consumed by `skopeo`, `crane`, or\n`podman load`.\n\nRequires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`)."}, + {Key: CmdOciBuild, Short: "[experimental] Build an OCI image from the current mise.toml", Long: "[experimental] Build an OCI image from the current mise.toml\n\nEach tool version becomes its own content-addressable OCI layer. Bumping a\ntool version only invalidates that tool's layer — other tools, the base\nimage, and config are reused unchanged. The output directory conforms to\nthe OCI image-layout spec and can be consumed by `skopeo`, `crane`, or\n`podman load`.\n\nRequires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`).", AfterLongHelp: "Examples:\n\n Build with defaults (debian:bookworm-slim base):\n $ mise oci build\n\n Build with a specific base image and tag:\n $ mise oci build --from ubuntu:24.04 --tag myorg/dev:latest -o ./img\n\n Inspect the result with skopeo:\n $ skopeo inspect oci:./mise-oci\n\n Push to a registry:\n $ mise oci push --image-dir ./mise-oci ghcr.io/me/dev:latest\n\nNotes:\n\n - The image only contains tools from the project's mise config (and\n any configs at-or-below the project root). Tools from\n `~/.config/mise/config.toml` are not included; pass --include-global\n to package them too.\n - asdf and vfox plugins are not supported in v1; use a different backend\n (core, aqua, ubi, github, cargo, npm, go, pipx, spm, http) for each tool.\n - The host mise binary is embedded at /usr/local/bin/mise by default;\n build on the same OS/arch as your target image (or pass --no-mise).\n"}, {Key: FlagOciBuildCopy, Repeatable: true, ValueName: "HOST_PATH:IMAGE_PATH", ValueDemanded: true, Short: "Copy a host file, directory, or symlink into the image (repeatable, HOST:IMAGE)", Long: "Copy a host file, directory, or symlink into the image (repeatable, HOST:IMAGE)"}, {Key: FlagOciBuildOutput, ValueName: "OUTPUT", ValueDemanded: true, Short: "Output directory for the OCI image layout", Long: "Output directory for the OCI image layout", Default: []string{"./mise-oci"}}, {Key: FlagOciBuildFrom, ValueName: "FROM", ValueDemanded: true, Short: "Base image reference (overrides [oci].from and the oci.default_from setting)", Long: "Base image reference (overrides [oci].from and the oci.default_from setting)"}, @@ -5406,7 +5406,7 @@ var HelpText = argv.HelpTable{ {Key: FlagOciBuildMountPoint, ValueName: "MOUNT_POINT", ValueDemanded: true, Short: "Where to place tool installs inside the image (default: /mise)", Long: "Where to place tool installs inside the image (default: /mise)"}, {Key: FlagOciBuildNoMise, Short: "Do not embed the currently-running mise binary at /usr/local/bin/mise", Long: "Do not embed the currently-running mise binary at /usr/local/bin/mise"}, {Key: FlagOciBuildOwner, ValueName: "UID[:GID]", ValueDemanded: true, Short: "UID[:GID] to assign to every tar entry in generated layers", Long: "UID[:GID] to assign to every tar entry in generated layers\n\nOverrides [oci].user_id / [oci].group_id. Defaults to 0:0. If GID is omitted, it defaults to UID. This affects file ownership only; [oci].user controls the image USER directive."}, - {Key: CmdOciPush, Short: "[experimental] Build an OCI image and push it to a registry", Long: "[experimental] Build an OCI image and push it to a registry\n\nPushes with mise's built-in registry client — no skopeo/crane/docker\nrequired. If `--image-dir` is not passed, builds fresh from the current\nmise.toml first. Only blobs the registry doesn't already have are\nuploaded, so repeat pushes of mostly-unchanged toolsets are cheap.\n\nTool layers whose tool, version, mount point, and file owner match the\npreviously pushed image (or `--cache-from`) are reused without being\nrebuilt — those tools don't even need to be installed locally. Pass\n`--no-cache` to force a full local rebuild.\n\nCredentials are read from the same places docker and podman use:\n`$REGISTRY_AUTH_FILE`, `$XDG_RUNTIME_DIR/containers/auth.json`,\n`~/.config/containers/auth.json`, and `~/.docker/config.json`\n(including credential helpers) — so `docker login` / `podman login`\nis all the setup needed.\n\nRequires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`)."}, + {Key: CmdOciPush, Short: "[experimental] Build an OCI image and push it to a registry", Long: "[experimental] Build an OCI image and push it to a registry\n\nPushes with mise's built-in registry client — no skopeo/crane/docker\nrequired. If `--image-dir` is not passed, builds fresh from the current\nmise.toml first. Only blobs the registry doesn't already have are\nuploaded, so repeat pushes of mostly-unchanged toolsets are cheap.\n\nTool layers whose tool, version, mount point, and file owner match the\npreviously pushed image (or `--cache-from`) are reused without being\nrebuilt — those tools don't even need to be installed locally. Pass\n`--no-cache` to force a full local rebuild.\n\nCredentials are read from the same places docker and podman use:\n`$REGISTRY_AUTH_FILE`, `$XDG_RUNTIME_DIR/containers/auth.json`,\n`~/.config/containers/auth.json`, and `~/.docker/config.json`\n(including credential helpers) — so `docker login` / `podman login`\nis all the setup needed.\n\nRequires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`).", AfterLongHelp: "Examples:\n\n Build and push to GHCR:\n $ mise oci push ghcr.io/me/devenv:latest\n\n Push an image built earlier:\n $ mise oci build -o ./img\n $ mise oci push --image-dir ./img ghcr.io/me/devenv:v1\n\nAuth:\n\n Credentials are resolved the same way docker/podman resolve them:\n $REGISTRY_AUTH_FILE, $XDG_RUNTIME_DIR/containers/auth.json,\n ~/.config/containers/auth.json, then ~/.docker/config.json\n (inline auths and credential helpers). Log in with either:\n $ docker login ghcr.io\n $ podman login ghcr.io\n"}, {Key: FlagOciPushCacheFrom, ValueName: "REF", ValueDemanded: true, Short: "Reuse unchanged tool layers from this image instead of the destination ref", Long: "Reuse unchanged tool layers from this image instead of the destination ref\n\nMust live in the same repository as the destination. Useful when each push gets a unique tag (e.g. per-commit tags in CI): `--cache-from ghcr.io/me/dev:latest ghcr.io/me/dev:$SHA`."}, {Key: FlagOciPushFrom, ValueName: "FROM", ValueDemanded: true, Short: "Base image for the build (ignored with --image-dir)", Long: "Base image for the build (ignored with --image-dir)"}, {Key: FlagOciPushImageDir, ValueName: "IMAGE_DIR", ValueDemanded: true, Short: "Push an already-built OCI image layout (skip the build step)", Long: "Push an already-built OCI image layout (skip the build step)"}, @@ -5417,7 +5417,7 @@ var HelpText = argv.HelpTable{ {Key: FlagOciPushOwner, ValueName: "UID[:GID]", ValueDemanded: true, Short: "UID[:GID] to assign to every tar entry when building (conflicts with --image-dir)", Long: "UID[:GID] to assign to every tar entry when building (conflicts with --image-dir)\n\nOverrides [oci].user_id / [oci].group_id. Defaults to 0:0. If GID is omitted, it defaults to UID. This affects file ownership only; [oci].user controls the image USER directive."}, {Key: FlagOciPushUpdateIndex, Short: "Maintain the tag as a multi-arch image index", Long: "Maintain the tag as a multi-arch image index\n\nPushes this build's manifest by digest and points the tag at an OCI image index containing one entry per platform, preserving entries other architectures pushed. Run `mise oci push --update-index` from one runner per platform to assemble a multi-arch tag."}, {Key: ArgOciPushRef, Demanded: true, Short: "Destination registry reference (e.g. `ghcr.io/me/devenv:latest`)", Long: "Destination registry reference (e.g. `ghcr.io/me/devenv:latest`)"}, - {Key: CmdOciRun, Short: "[experimental] Build an OCI image from the current mise.toml and run a command in it", Long: "[experimental] Build an OCI image from the current mise.toml and run a command in it\n\nEquivalent to `mise oci build` followed by `docker run` / `podman run`.\nThe built image is loaded into the local container engine (podman pulls\nthe OCI layout natively; docker receives it via `docker load`) and the\ngiven command is executed inside it with stdin/stdout/stderr inherited.\n\nRequires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`) and\none of: `podman`, `docker`."}, + {Key: CmdOciRun, Short: "[experimental] Build an OCI image from the current mise.toml and run a command in it", Long: "[experimental] Build an OCI image from the current mise.toml and run a command in it\n\nEquivalent to `mise oci build` followed by `docker run` / `podman run`.\nThe built image is loaded into the local container engine (podman pulls\nthe OCI layout natively; docker receives it via `docker load`) and the\ngiven command is executed inside it with stdin/stdout/stderr inherited.\n\nRequires `mise settings experimental=true` (or `MISE_EXPERIMENTAL=1`) and\none of: `podman`, `docker`.", AfterLongHelp: "Examples:\n\n Build the current mise.toml and drop into bash:\n $ mise oci run -it -- bash\n\n Run a one-shot command with env + volume (note: `-v` is reserved\n for --verbose, so use `--volume`):\n $ mise oci run -e DEBUG=1 --volume $PWD:/work -w /work -- npm test\n\n Re-use a previously built layout (skip the build step):\n $ mise oci build -o ./img && mise oci run --image-dir ./img -- node -e 'console.log(process.version)'\n\nEngines:\n\n Prefers podman (loads OCI layouts natively). Falls back to docker\n (loaded via docker load). Pass --engine podman or --engine docker to override.\n"}, {Key: FlagOciRunEngine, ValueName: "ENGINE", ValueDemanded: true, Short: "Container engine to use (`auto`, `podman`, or `docker`)", Long: "Container engine to use (`auto`, `podman`, or `docker`)", Choices: []string{"auto", "podman", "docker"}, Default: []string{"auto"}}, {Key: FlagOciRunFrom, ValueName: "FROM", ValueDemanded: true, Short: "Base image reference for the build (ignored with --image-dir)", Long: "Base image reference for the build (ignored with --image-dir)"}, {Key: FlagOciRunImageDir, ValueName: "IMAGE_DIR", ValueDemanded: true, Short: "Use an already-built OCI image layout instead of building fresh", Long: "Use an already-built OCI image layout instead of building fresh"}, @@ -5432,7 +5432,7 @@ var HelpText = argv.HelpTable{ {Key: FlagOciRunTty, Short: "Allocate a TTY (pass `-t` to the engine)", Long: "Allocate a TTY (pass `-t` to the engine)"}, {Key: FlagOciRunWorkdir, ValueName: "WORKDIR", ValueDemanded: true, Short: "Working directory inside the container", Long: "Working directory inside the container"}, {Key: ArgOciRunCmd, Short: "Command and arguments to run inside the container (after `--`)", Long: "Command and arguments to run inside the container (after `--`)"}, - {Key: CmdOutdated, Short: "Shows outdated tool versions", Long: "Shows outdated tool versions\n\nSee `mise upgrade` to upgrade these versions."}, + {Key: CmdOutdated, Short: "Shows outdated tool versions", Long: "Shows outdated tool versions\n\nSee `mise upgrade` to upgrade these versions.", AfterLongHelp: "Examples:\n\n $ mise outdated\n Plugin Requested Current Latest\n python 3.11 3.11.0 3.11.1\n node 20 20.0.0 20.1.0\n\n $ mise outdated node\n Plugin Requested Current Latest\n node 20 20.0.0 20.1.0\n\n $ mise outdated --json\n {\"python\": {\"requested\": \"3.11\", \"current\": \"3.11.0\", \"latest\": \"3.11.1\"}, ...}\n\n $ mise outdated --local\n Plugin Requested Current Latest\n node 20 20.0.0 20.1.0\n"}, {Key: FlagOutdatedJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagOutdatedBump, Short: "Compares against the latest versions available, not what matches the current config", Long: "Compares against the latest versions available, not what matches the current config\n\nFor example, if you have `node = \"20\"` in your config by default `mise outdated` will only\nshow other 20.x versions, not 21.x or 22.x versions.\n\nUsing this flag, if there are 21.x or newer versions it will display those instead of 20.x."}, {Key: FlagOutdatedInactive, Short: "Show outdated tools including installed-but-inactive tools not present in the current config", Long: "Show outdated tools including installed-but-inactive tools not present in the current config\n\nBy default, `mise outdated` only shows tools that come from the current config."}, @@ -5440,7 +5440,7 @@ var HelpText = argv.HelpTable{ {Key: FlagOutdatedMonorepo, Short: "Placeholder for future monorepo outdated checks; `mise outdated --monorepo` is not implemented yet.", Long: "Placeholder for future monorepo outdated checks; `mise outdated --monorepo` is not implemented yet."}, {Key: FlagOutdatedNoHeader, Short: "Don't show table header", Long: "Don't show table header"}, {Key: ArgOutdatedToolVersion, Short: "Tool(s) to show outdated versions for\ne.g.: node@20 python@3.10\nIf not specified, all tools in global and local configs will be shown", Long: "Tool(s) to show outdated versions for\ne.g.: node@20 python@3.10\nIf not specified, all tools in global and local configs will be shown"}, - {Key: CmdPatrons, Short: "Show the individuals supporting mise as Patron-tier members", Long: "Show the individuals supporting mise as Patron-tier members\n\nLists the individuals on the Patron tier from .\nThe list refreshes daily; supporting terminals will render each patron's\nname as a clickable link via OSC 8 hyperlinks.\n\nTo appear here, become a patron at ."}, + {Key: CmdPatrons, Short: "Show the individuals supporting mise as Patron-tier members", Long: "Show the individuals supporting mise as Patron-tier members\n\nLists the individuals on the Patron tier from .\nThe list refreshes daily; supporting terminals will render each patron's\nname as a clickable link via OSC 8 hyperlinks.\n\nTo appear here, become a patron at .", AfterLongHelp: "Examples:\n\n $ mise patrons\n $ mise patrons -J\n $ mise patrons --refresh"}, {Key: FlagPatronsJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagPatronsRefresh, Short: "Bypass the local cache and re-fetch", Long: "Bypass the local cache and re-fetch"}, {Key: CmdPlugins, Short: "Manage plugins", VisibleAliases: []string{"p"}}, @@ -5449,7 +5449,7 @@ var HelpText = argv.HelpTable{ {Key: FlagPluginsUrls, Short: "Show the git url for each plugin\ne.g.: https://github.com/mise-plugins/vfox-cmake.git", Long: "Show the git url for each plugin\ne.g.: https://github.com/mise-plugins/vfox-cmake.git"}, {Key: FlagPluginsRefs, Hide: true, Short: "Show the git refs for each plugin\ne.g.: main 1234abc", Long: "Show the git refs for each plugin\ne.g.: main 1234abc"}, {Key: FlagPluginsUser, Short: "List installed plugins", Long: "List installed plugins\n\nThis is the default behavior but can be used with --core\nto show core and user plugins"}, - {Key: CmdPluginsInstall, Short: "Install a plugin", Long: "Install a plugin\n\nnote that mise can automatically install plugins when you install a tool\ne.g.: `mise install cmake@3.30` will autoinstall the cmake plugin\n\nThis behavior can be modified in ~/.config/mise/config.toml", VisibleAliases: []string{"i", "a", "add"}}, + {Key: CmdPluginsInstall, Short: "Install a plugin", Long: "Install a plugin\n\nnote that mise can automatically install plugins when you install a tool\ne.g.: `mise install cmake@3.30` will autoinstall the cmake plugin\n\nThis behavior can be modified in ~/.config/mise/config.toml", VisibleAliases: []string{"i", "a", "add"}, AfterLongHelp: "Examples:\n\n # install the poetry via shorthand\n $ mise plugins install poetry\n\n # install the poetry plugin using a specific git url\n $ mise plugins install poetry https://github.com/mise-plugins/mise-poetry.git\n\n # install the poetry plugin using the git url only\n # (poetry is inferred from the url)\n $ mise plugins install https://github.com/mise-plugins/mise-poetry.git\n\n # install the poetry plugin using a specific ref\n $ mise plugins install poetry https://github.com/mise-plugins/mise-poetry.git#11d0c1e\n"}, {Key: FlagPluginsInstallAll, Short: "Install all missing plugins\nThis will only install plugins that have matching shorthands.\ni.e.: they don't need the full git repo url", Long: "Install all missing plugins\nThis will only install plugins that have matching shorthands.\ni.e.: they don't need the full git repo url"}, {Key: FlagPluginsInstallForce, Short: "Reinstall even if plugin exists", Long: "Reinstall even if plugin exists"}, {Key: FlagPluginsInstallJobs, ValueName: "JOBS", ValueDemanded: true, Short: "Number of jobs to run in parallel", Long: "Number of jobs to run in parallel"}, @@ -5457,11 +5457,11 @@ var HelpText = argv.HelpTable{ {Key: ArgPluginsInstallNewPlugin, Short: "The name of the plugin to install\ne.g.: cmake, poetry\nCan specify multiple plugins: `mise plugins install cmake poetry`", Long: "The name of the plugin to install\ne.g.: cmake, poetry\nCan specify multiple plugins: `mise plugins install cmake poetry`"}, {Key: ArgPluginsInstallGitUrl, Short: "The git url of the plugin", Long: "The git url of the plugin"}, {Key: ArgPluginsInstallRest, Hide: true}, - {Key: CmdPluginsLink, Short: "Symlinks a plugin into mise", Long: "Symlinks a plugin into mise\n\nThis is used for developing a plugin.", VisibleAliases: []string{"ln"}}, + {Key: CmdPluginsLink, Short: "Symlinks a plugin into mise", Long: "Symlinks a plugin into mise\n\nThis is used for developing a plugin.", VisibleAliases: []string{"ln"}, AfterLongHelp: "Examples:\n\n # essentially just `ln -s ./vfox-cmake ~/.local/share/mise/plugins/cmake`\n $ mise plugins link cmake ./vfox-cmake\n\n # infer plugin name as \"cmake\"\n $ mise plugins link ./vfox-cmake\n"}, {Key: FlagPluginsLinkForce, Short: "Overwrite existing plugin", Long: "Overwrite existing plugin"}, {Key: ArgPluginsLinkName, Demanded: true, Short: "The name of the plugin\ne.g.: cmake, poetry", Long: "The name of the plugin\ne.g.: cmake, poetry"}, {Key: ArgPluginsLinkDir, Short: "The local path to the plugin\ne.g.: ./vfox-cmake", Long: "The local path to the plugin\ne.g.: ./vfox-cmake"}, - {Key: CmdPluginsLs, Short: "List installed plugins", Long: "List installed plugins\n\nCan also show remotely available plugins to install.", VisibleAliases: []string{"list"}}, + {Key: CmdPluginsLs, Short: "List installed plugins", Long: "List installed plugins\n\nCan also show remotely available plugins to install.", VisibleAliases: []string{"list"}, AfterLongHelp: "Examples:\n\n $ mise plugins ls\n cmake\n poetry\n\n $ mise plugins ls --urls\n cmake https://github.com/mise-plugins/vfox-cmake.git\n poetry https://github.com/mise-plugins/vfox-poetry.git\n"}, {Key: FlagPluginsLsAll, Hide: true, Short: "List all available remote plugins\nSame as `mise plugins ls-remote`", Long: "List all available remote plugins\nSame as `mise plugins ls-remote`"}, {Key: FlagPluginsLsCore, Hide: true, Short: "The built-in plugins only\nNormally these are not shown", Long: "The built-in plugins only\nNormally these are not shown"}, {Key: FlagPluginsLsOutdated, Short: "Show plugins with available updates\nChecks the remote for newer versions and only displays plugins that are outdated", Long: "Show plugins with available updates\nChecks the remote for newer versions and only displays plugins that are outdated"}, @@ -5471,14 +5471,14 @@ var HelpText = argv.HelpTable{ {Key: CmdPluginsLsRemote, Short: "List all available remote plugins", Long: "\nList all available remote plugins\n\nThe full list is here: https://github.com/jdx/mise/blob/main/registry/\n\nExamples:\n\n $ mise plugins ls-remote\n", VisibleAliases: []string{"list-remote", "list-all"}}, {Key: FlagPluginsLsRemoteUrls, Short: "Show the git url for each plugin e.g.: https://github.com/mise-plugins/mise-poetry.git", Long: "Show the git url for each plugin e.g.: https://github.com/mise-plugins/mise-poetry.git"}, {Key: FlagPluginsLsRemoteOnlyNames, Short: "Only show the name of each plugin by default it will show a \"*\" next to installed plugins", Long: "Only show the name of each plugin by default it will show a \"*\" next to installed plugins"}, - {Key: CmdPluginsUninstall, Short: "Removes a plugin", VisibleAliases: []string{"remove", "rm"}}, + {Key: CmdPluginsUninstall, Short: "Removes a plugin", VisibleAliases: []string{"remove", "rm"}, AfterLongHelp: "Examples:\n\n $ mise plugins uninstall cmake\n"}, {Key: FlagPluginsUninstallAll, Short: "Remove all plugins", Long: "Remove all plugins"}, {Key: FlagPluginsUninstallPurge, Short: "Also remove the plugin's installs, downloads, and cache", Long: "Also remove the plugin's installs, downloads, and cache"}, {Key: ArgPluginsUninstallPlugin, Short: "Plugin(s) to remove", Long: "Plugin(s) to remove"}, - {Key: CmdPluginsUpdate, Short: "Updates a plugin to the latest version", Long: "Updates a plugin to the latest version\n\nnote: this updates the plugin itself, not the runtime versions", VisibleAliases: []string{"up", "upgrade"}}, + {Key: CmdPluginsUpdate, Short: "Updates a plugin to the latest version", Long: "Updates a plugin to the latest version\n\nnote: this updates the plugin itself, not the runtime versions", VisibleAliases: []string{"up", "upgrade"}, AfterLongHelp: "Examples:\n\n $ mise plugins update # update all plugins\n $ mise plugins update cmake # update only cmake\n $ mise plugins update cmake#beta # specify a ref\n"}, {Key: FlagPluginsUpdateJobs, ValueName: "JOBS", ValueDemanded: true, Short: "Number of jobs to run in parallel\nDefault: 4", Long: "Number of jobs to run in parallel\nDefault: 4"}, {Key: ArgPluginsUpdatePlugin, Short: "Plugin(s) to update", Long: "Plugin(s) to update"}, - {Key: CmdDeps, Short: "[experimental] Manage project dependencies", Long: "[experimental] Manage project dependencies\n\nRuns all applicable dependency install steps for the current project.\nThis checks if dependency lockfiles are newer than installed outputs\n(e.g., package-lock.json vs node_modules/) and runs install commands\nif needed.\n\nProviders with `auto = true` are automatically invoked before `mise x` and `mise run`\nunless skipped with the --no-deps flag.", VisibleAliases: []string{"dep"}}, + {Key: CmdDeps, Short: "[experimental] Manage project dependencies", Long: "[experimental] Manage project dependencies\n\nRuns all applicable dependency install steps for the current project.\nThis checks if dependency lockfiles are newer than installed outputs\n(e.g., package-lock.json vs node_modules/) and runs install commands\nif needed.\n\nProviders with `auto = true` are automatically invoked before `mise x` and `mise run`\nunless skipped with the --no-deps flag.", VisibleAliases: []string{"dep"}, AfterLongHelp: "Examples:\n\n $ mise deps # Install all project dependencies\n $ mise deps install # Same as bare `mise deps`\n $ mise deps install --force # Force reinstall even if fresh\n $ mise deps install --dry-run # Show what would run\n $ mise deps --monorepo # Install deps from explicit monorepo config roots\n $ mise deps add npm:react # Add a dependency\n $ mise deps add -D npm:vitest # Add a dev dependency\n $ mise deps remove npm:lodash # Remove a dependency\n\nConfiguration:\n\n```toml\n# Built-in npm provider (auto-detects lockfile)\n[deps.npm]\nauto = true # Auto-run before mise x/run\n\n# Custom provider\n[deps.codegen]\nauto = true\nsources = [\"schema/*.graphql\"]\noutputs = [\"src/generated/\"]\nrun = \"npm run codegen\"\n\n[deps]\ndisable = [\"npm\"] # Disable specific providers at runtime\n```\n"}, {Key: FlagDepsExplain, Short: "Show why a provider is fresh or stale (requires a provider argument)", Long: "Show why a provider is fresh or stale (requires a provider argument)"}, {Key: FlagDepsForce, Short: "Force run all deps steps even if outputs are fresh", Long: "Force run all deps steps even if outputs are fresh"}, {Key: FlagDepsDryRun, Short: "Only check if deps install is needed, don't run commands", Long: "Only check if deps install is needed, don't run commands"}, @@ -5501,14 +5501,14 @@ var HelpText = argv.HelpTable{ {Key: ArgDepsInstallProvider, Short: "Provider to operate on (runs only this provider, or use with --explain)", Long: "Provider to operate on (runs only this provider, or use with --explain)"}, {Key: CmdDepsRemove, Short: "Remove a dependency", Long: "Remove a dependency\n\nRemoves one or more packages from the project using the appropriate package manager.\nPackage specs use the format `ecosystem:package`, e.g., `npm:lodash`."}, {Key: ArgDepsRemovePackages, Demanded: true, Short: "Package(s) to remove (e.g., npm:lodash)", Long: "Package(s) to remove (e.g., npm:lodash)"}, - {Key: CmdPrune, Short: "Delete unused versions of tools", Long: "Delete unused versions of tools\n\nmise tracks which config files have been used in ~/.local/state/mise/tracked-configs\nVersions which are no longer the latest specified in any of those configs are deleted.\nVersions installed only with environment variables `MISE__VERSION` will be deleted,\nas will versions only referenced on the command line `mise exec @`.\n\nTool stubs that have been executed are tracked in ~/.local/state/mise/tracked-stubs.\nVersions still referenced by a tracked stub are not deleted.\n\nYou can list prunable tools with `mise ls --prunable`"}, + {Key: CmdPrune, Short: "Delete unused versions of tools", Long: "Delete unused versions of tools\n\nmise tracks which config files have been used in ~/.local/state/mise/tracked-configs\nVersions which are no longer the latest specified in any of those configs are deleted.\nVersions installed only with environment variables `MISE__VERSION` will be deleted,\nas will versions only referenced on the command line `mise exec @`.\n\nTool stubs that have been executed are tracked in ~/.local/state/mise/tracked-stubs.\nVersions still referenced by a tracked stub are not deleted.\n\nYou can list prunable tools with `mise ls --prunable`", AfterLongHelp: "Examples:\n\n $ mise prune --dry-run\n rm -rf ~/.local/share/mise/versions/node/20.0.0\n rm -rf ~/.local/share/mise/versions/node/20.0.1\n"}, {Key: FlagPruneDryRun, Short: "Do not actually delete anything", Long: "Do not actually delete anything"}, {Key: FlagPruneConfigs, Short: "Prune only tracked and trusted configuration links that point to nonexistent configurations", Long: "Prune only tracked and trusted configuration links that point to nonexistent configurations"}, {Key: FlagPruneDryRunCode, Short: "Like --dry-run but exits with code 1 if there are tools to prune", Long: "Like --dry-run but exits with code 1 if there are tools to prune\n\nThis is useful for scripts to check if tools need to be pruned."}, {Key: FlagPruneMonorepo, Short: "Placeholder for future monorepo pruning; `mise prune --monorepo` is not implemented yet.", Long: "Placeholder for future monorepo pruning; `mise prune --monorepo` is not implemented yet."}, {Key: FlagPruneTools, Short: "Prune only unused versions of tools", Long: "Prune only unused versions of tools"}, {Key: ArgPruneInstalledTool, Short: "Prune only these tools", Long: "Prune only these tools"}, - {Key: CmdRegistry, Short: "List available tools to install", Long: "List available tools to install\n\nThis command lists the tools available in the registry as shorthand names.\n\nFor example, `poetry` is shorthand for `asdf:mise-plugins/mise-poetry`."}, + {Key: CmdRegistry, Short: "List available tools to install", Long: "List available tools to install\n\nThis command lists the tools available in the registry as shorthand names.\n\nFor example, `poetry` is shorthand for `asdf:mise-plugins/mise-poetry`.", AfterLongHelp: "Examples:\n\n $ mise registry\n node core:node\n poetry asdf:mise-plugins/mise-poetry\n ubi cargo:ubi-cli\n\n $ mise registry poetry\n asdf:mise-plugins/mise-poetry\n"}, {Key: FlagRegistryBackend, ValueName: "BACKEND", ValueDemanded: true, Short: "Show only tools for this backend", Long: "Show only tools for this backend"}, {Key: FlagRegistryComplete, Hide: true, Short: "Print all tools with descriptions for shell completions", Long: "Print all tools with descriptions for shell completions"}, {Key: FlagRegistryHideAliased, Short: "Hide aliased tools", Long: "Hide aliased tools"}, @@ -5516,11 +5516,11 @@ var HelpText = argv.HelpTable{ {Key: FlagRegistrySecurity, Short: "Include security features for each tool's backends in JSON output", Long: "Include security features for each tool's backends in JSON output.\n\nRequires --json. Security info is de-duplicated across all of a tool's backends. This can add noticeable time for large listings since each backend's security info is resolved individually."}, {Key: ArgRegistryName, Short: "Show only the specified tool's full name", Long: "Show only the specified tool's full name"}, {Key: CmdRenderHelp, Hide: true, Short: "internal command to generate markdown from help"}, - {Key: CmdReshim, Short: "Creates new shims based on bin paths from currently installed tools.", Long: "Creates new shims based on bin paths from currently installed tools.\n\nThis creates new shims in ~/.local/share/mise/shims for CLIs that have been added.\nmise will try to do this automatically for commands like `npm i -g` but there are\nother ways to install things (like using yarn or pnpm for node) that mise does\nnot know about and so it will be necessary to call this explicitly.\n\nIf you think mise should automatically call this for a particular command, please\nopen an issue on the mise repo. You can also set up a shell function to reshim\nautomatically (it's really fast so you don't need to worry about overhead):\n\n npm() {\n command npm \"$@\"\n mise reshim\n }\n\nNote that this creates shims for _all_ installed tools, not just the ones that are\ncurrently active in mise.toml."}, + {Key: CmdReshim, Short: "Creates new shims based on bin paths from currently installed tools.", Long: "Creates new shims based on bin paths from currently installed tools.\n\nThis creates new shims in ~/.local/share/mise/shims for CLIs that have been added.\nmise will try to do this automatically for commands like `npm i -g` but there are\nother ways to install things (like using yarn or pnpm for node) that mise does\nnot know about and so it will be necessary to call this explicitly.\n\nIf you think mise should automatically call this for a particular command, please\nopen an issue on the mise repo. You can also set up a shell function to reshim\nautomatically (it's really fast so you don't need to worry about overhead):\n\n npm() {\n command npm \"$@\"\n mise reshim\n }\n\nNote that this creates shims for _all_ installed tools, not just the ones that are\ncurrently active in mise.toml.", AfterLongHelp: "Examples:\n\n $ mise reshim\n $ ~/.local/share/mise/shims/node -v\n v20.0.0\n"}, {Key: FlagReshimForce, Short: "Removes all shims before reshimming", Long: "Removes all shims before reshimming"}, {Key: ArgReshimTool, Hide: true}, {Key: ArgReshimVersion, Hide: true}, - {Key: CmdRun, Short: "Run task(s)", Long: "Run task(s)\n\nThis command will run a task, or multiple tasks in parallel.\nTasks may have dependencies on other tasks or on source files.\nIf source is configured on a task, it will only run if the source\nfiles have changed.\n\nTasks can be defined in mise.toml or as standalone scripts.\nIn mise.toml, tasks take this form:\n\n [tasks.build]\n run = \"npm run build\"\n sources = [\"src/**/*.ts\"]\n outputs = [\"dist/**/*.js\"]\n\nAlternatively, tasks can be defined as standalone scripts.\nThese must be located in `mise-tasks`, `.mise-tasks`, `.mise/tasks`, `mise/tasks` or\n`.config/mise/tasks`.\nThe name of the script will be the name of the tasks.\n\n $ cat .mise/tasks/build<` to create/modify environment-specific config files like `mise..toml`."}, + {Key: CmdSet, Short: "Set environment variables in mise.toml", Long: "Set environment variables in mise.toml\n\nBy default, this command modifies `mise.toml` in the current directory.\nIf multiple config files exist (e.g., both `mise.toml` and `mise.local.toml`),\nthe lowest precedence file (`mise.toml`) will be used.\nSee https://mise.jdx.dev/configuration.html#target-file-for-write-operations\n\nUse `-E ` to create/modify environment-specific config files like `mise..toml`.", AfterLongHelp: "Examples:\n\n $ mise set NODE_ENV=production\n\n $ mise set NODE_ENV\n production\n\n $ mise set -E staging NODE_ENV=staging\n # creates or modifies mise.staging.toml\n\n $ mise set\n key value source\n NODE_ENV production ~/.config/mise/config.toml\n\n $ mise set --prompt PASSWORD\n Enter value for PASSWORD: [hidden input]\n\n Multiline Values (--stdin):\n\n $ cat private.key | mise set --stdin MY_KEY\n\n $ printf \"line1\\nline2\" | mise set --stdin MY_KEY\n\n [experimental] Age Encryption:\n\n $ mise set --age-encrypt API_KEY=secret\n\n $ mise set --age-encrypt --prompt API_KEY\n Enter value for API_KEY: [hidden input]\n"}, {Key: FlagSetEnv, ValueName: "ENV", ValueDemanded: true, Short: "Create/modify an environment-specific config file like .mise..toml", Long: "Create/modify an environment-specific config file like .mise..toml"}, {Key: FlagSetGlobal, Short: "Set the environment variable in the global config file", Long: "Set the environment variable in the global config file"}, {Key: FlagSetAgeEncrypt, Short: "[experimental] Encrypt the value with age before storing", Long: "[experimental] Encrypt the value with age before storing"}, @@ -5582,7 +5582,7 @@ var HelpText = argv.HelpTable{ {Key: FlagSetRemove, Hide: true, Repeatable: true, ValueName: "ENV_KEY", ValueDemanded: true, Short: "Remove the environment variable from config file", Long: "Remove the environment variable from config file\n\nCan be used multiple times."}, {Key: FlagSetStdin, Short: "Read the value from stdin (for multiline input)", Long: "Read the value from stdin (for multiline input)\n\nWhen using --stdin, provide a single key without a value. The value will be read from stdin until EOF."}, {Key: ArgSetEnvVar, Short: "Environment variable(s) to set\ne.g.: NODE_ENV=production", Long: "Environment variable(s) to set\ne.g.: NODE_ENV=production"}, - {Key: CmdSettings, Short: "Manage settings", Long: "Show current settings\n\nThis is the contents of ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias`"}, + {Key: CmdSettings, Short: "Manage settings", Long: "Show current settings\n\nThis is the contents of ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias`", AfterLongHelp: "Examples:\n # list all settings\n $ mise settings\n\n # get the value of the setting \"always_keep_download\"\n $ mise settings always_keep_download\n\n # set the value of the setting \"always_keep_download\" to \"true\"\n $ mise settings always_keep_download=true\n\n # set the value of the setting \"node.mirror_url\" to \"https://npmmirror.com/mirrors/node/\"\n $ mise settings node.mirror_url https://npmmirror.com/mirrors/node/\n"}, {Key: FlagSettingsAll, Short: "List all settings", Long: "List all settings"}, {Key: FlagSettingsJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagSettingsLocal, Short: "Use the local config file instead of the global one", Long: "Use the local config file instead of the global one"}, @@ -5591,14 +5591,14 @@ var HelpText = argv.HelpTable{ {Key: FlagSettingsJsonExtended, Short: "Output in JSON format with sources", Long: "Output in JSON format with sources"}, {Key: ArgSettingsSetting, Short: "Name of setting", Long: "Name of setting"}, {Key: ArgSettingsValue, Short: "Setting value to set", Long: "Setting value to set"}, - {Key: CmdSettingsAdd, Short: "Adds a setting to the configuration file", Long: "Adds a setting to the configuration file\n\nUsed with an array setting, this will append the value to the array.\nThis modifies the contents of ~/.config/mise/config.toml"}, + {Key: CmdSettingsAdd, Short: "Adds a setting to the configuration file", Long: "Adds a setting to the configuration file\n\nUsed with an array setting, this will append the value to the array.\nThis modifies the contents of ~/.config/mise/config.toml", AfterLongHelp: "Examples:\n\n $ mise settings add disable_hints python_multi\n"}, {Key: FlagSettingsAddLocal, Short: "Use the local config file instead of the global one", Long: "Use the local config file instead of the global one"}, {Key: ArgSettingsAddSetting, Demanded: true, Short: "The setting to set", Long: "The setting to set"}, {Key: ArgSettingsAddValue, Short: "The value to set (optional if provided as KEY=VALUE)", Long: "The value to set (optional if provided as KEY=VALUE)"}, - {Key: CmdSettingsGet, Short: "Show a current setting", Long: "Show a current setting\n\nThis is the contents of a single entry in ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias get`"}, + {Key: CmdSettingsGet, Short: "Show a current setting", Long: "Show a current setting\n\nThis is the contents of a single entry in ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias get`", AfterLongHelp: "Examples:\n\n $ mise settings get idiomatic_version_file\n true\n"}, {Key: FlagSettingsGetLocal, Short: "Use the local config file instead of the global one", Long: "Use the local config file instead of the global one"}, {Key: ArgSettingsGetSetting, Demanded: true, Short: "The setting to show", Long: "The setting to show"}, - {Key: CmdSettingsLs, Short: "Show current settings", Long: "Show current settings\n\nThis is the contents of ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias`", VisibleAliases: []string{"list"}}, + {Key: CmdSettingsLs, Short: "Show current settings", Long: "Show current settings\n\nThis is the contents of ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias`", VisibleAliases: []string{"list"}, AfterLongHelp: "Examples:\n\n $ mise settings ls\n idiomatic_version_file = false\n ...\n\n $ mise settings ls python\n default_packages_file = \"~/.default-python-packages\"\n ...\n"}, {Key: FlagSettingsLsAll, Short: "List all settings", Long: "List all settings"}, {Key: FlagSettingsLsJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagSettingsLsLocal, Short: "Use the local config file instead of the global one", Long: "Use the local config file instead of the global one"}, @@ -5606,41 +5606,41 @@ var HelpText = argv.HelpTable{ {Key: FlagSettingsLsComplete, Hide: true, Short: "Print all settings with descriptions for shell completions", Long: "Print all settings with descriptions for shell completions"}, {Key: FlagSettingsLsJsonExtended, Short: "Output in JSON format with sources", Long: "Output in JSON format with sources"}, {Key: ArgSettingsLsSetting, Short: "Name of setting", Long: "Name of setting"}, - {Key: CmdSettingsSet, Short: "Add/update a setting", Long: "Add/update a setting\n\nThis modifies the contents of ~/.config/mise/config.toml by default.\nWith `--local`, modifies the local config file instead.\nSee https://mise.jdx.dev/configuration.html#target-file-for-write-operations", VisibleAliases: []string{"create"}}, + {Key: CmdSettingsSet, Short: "Add/update a setting", Long: "Add/update a setting\n\nThis modifies the contents of ~/.config/mise/config.toml by default.\nWith `--local`, modifies the local config file instead.\nSee https://mise.jdx.dev/configuration.html#target-file-for-write-operations", VisibleAliases: []string{"create"}, AfterLongHelp: "Examples:\n\n $ mise settings idiomatic_version_file=true\n"}, {Key: FlagSettingsSetLocal, Short: "Use the local config file instead of the global one", Long: "Use the local config file instead of the global one"}, {Key: ArgSettingsSetSetting, Demanded: true, Short: "The setting to set", Long: "The setting to set"}, {Key: ArgSettingsSetValue, Short: "The value to set (optional if provided as KEY=VALUE)", Long: "The value to set (optional if provided as KEY=VALUE)"}, - {Key: CmdSettingsUnset, Short: "Clears a setting", Long: "Clears a setting\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"rm", "remove", "delete", "del"}}, + {Key: CmdSettingsUnset, Short: "Clears a setting", Long: "Clears a setting\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"rm", "remove", "delete", "del"}, AfterLongHelp: "Examples:\n\n $ mise settings unset idiomatic_version_file\n"}, {Key: FlagSettingsUnsetLocal, Short: "Use the local config file instead of the global one", Long: "Use the local config file instead of the global one"}, {Key: ArgSettingsUnsetKey, Demanded: true, Short: "The setting to remove", Long: "The setting to remove"}, - {Key: CmdShell, Short: "Sets a tool version for the current session.", Long: "Sets a tool version for the current session.\n\nOnly works in a session where mise is already activated.\n\nThis works by setting environment variables for the current shell session\nsuch as `MISE_NODE_VERSION=20` which is \"eval\"ed as a shell function created by `mise activate`.", VisibleAliases: []string{"sh"}}, + {Key: CmdShell, Short: "Sets a tool version for the current session.", Long: "Sets a tool version for the current session.\n\nOnly works in a session where mise is already activated.\n\nThis works by setting environment variables for the current shell session\nsuch as `MISE_NODE_VERSION=20` which is \"eval\"ed as a shell function created by `mise activate`.", VisibleAliases: []string{"sh"}, AfterLongHelp: "Examples:\n\n $ mise shell node@20\n $ node -v\n v20.0.0\n"}, {Key: FlagShellJobs, ValueName: "JOBS", ValueDemanded: true, Short: "Number of jobs to run in parallel\n[default: 4]", Long: "Number of jobs to run in parallel\n[default: 4]"}, {Key: FlagShellUnset, Short: "Removes a previously set version", Long: "Removes a previously set version"}, {Key: FlagShellRaw, Short: "Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1", Long: "Connect backend install command stdin/stdout/stderr directly to the terminal Implies --jobs=1"}, {Key: ArgShellToolVersion, Demanded: true, Short: "Tool(s) to use", Long: "Tool(s) to use"}, {Key: CmdShellAlias, Short: "Manage shell aliases."}, {Key: FlagShellAliasNoHeader, Short: "Don't show table header", Long: "Don't show table header"}, - {Key: CmdShellAliasGet, Short: "Show the command for a shell alias"}, + {Key: CmdShellAliasGet, Short: "Show the command for a shell alias", AfterLongHelp: "Examples:\n\n $ mise shell-alias get ll\n ls -la\n"}, {Key: ArgShellAliasGetShellAlias, Demanded: true, Short: "The alias to show", Long: "The alias to show"}, - {Key: CmdShellAliasLs, Short: "List shell aliases", Long: "List shell aliases\n\nShows the shell aliases that are set in the current directory.\nThese are defined in `mise.toml` under the `[shell_alias]` section.", VisibleAliases: []string{"list"}}, + {Key: CmdShellAliasLs, Short: "List shell aliases", Long: "List shell aliases\n\nShows the shell aliases that are set in the current directory.\nThese are defined in `mise.toml` under the `[shell_alias]` section.", VisibleAliases: []string{"list"}, AfterLongHelp: "Examples:\n\n $ mise shell-alias ls\n alias command\n ll ls -la\n gs git status\n"}, {Key: FlagShellAliasLsNoHeader, Short: "Don't show table header", Long: "Don't show table header"}, - {Key: CmdShellAliasSet, Short: "Add/update a shell alias", Long: "Add/update a shell alias\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"add", "create"}}, + {Key: CmdShellAliasSet, Short: "Add/update a shell alias", Long: "Add/update a shell alias\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"add", "create"}, AfterLongHelp: "Examples:\n\n $ mise shell-alias set ll \"ls -la\"\n $ mise shell-alias set gs \"git status\"\n"}, {Key: ArgShellAliasSetShellAlias, Demanded: true, Short: "The alias name", Long: "The alias name"}, {Key: ArgShellAliasSetCommand, Short: "The command to run (optional if provided as ALIAS=COMMAND)", Long: "The command to run (optional if provided as ALIAS=COMMAND)"}, - {Key: CmdShellAliasUnset, Short: "Removes a shell alias", Long: "Removes a shell alias\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"rm", "remove", "delete", "del"}}, + {Key: CmdShellAliasUnset, Short: "Removes a shell alias", Long: "Removes a shell alias\n\nThis modifies the contents of ~/.config/mise/config.toml", VisibleAliases: []string{"rm", "remove", "delete", "del"}, AfterLongHelp: "Examples:\n\n $ mise shell-alias unset ll\n"}, {Key: ArgShellAliasUnsetShellAlias, Demanded: true, Short: "The alias to remove", Long: "The alias to remove"}, {Key: CmdSponsors, Short: "Show the companies sponsoring mise and the jdx.dev open source tools"}, {Key: CmdSync, Short: "Synchronize tools from other version managers with mise"}, - {Key: CmdSyncNode, Short: "Symlinks all tool versions from an external tool into mise", Long: "Symlinks all tool versions from an external tool into mise\n\nFor example, use this to import all Homebrew node installs into mise\n\nThis won't overwrite any existing installs but will overwrite any existing symlinks"}, + {Key: CmdSyncNode, Short: "Symlinks all tool versions from an external tool into mise", Long: "Symlinks all tool versions from an external tool into mise\n\nFor example, use this to import all Homebrew node installs into mise\n\nThis won't overwrite any existing installs but will overwrite any existing symlinks", AfterLongHelp: "Examples:\n\n $ brew install node@18 node@20\n $ mise sync node --brew\n $ mise use -g node@18 - uses Homebrew-provided node\n"}, {Key: FlagSyncNodeBrew, Short: "Get tool versions from Homebrew", Long: "Get tool versions from Homebrew"}, {Key: FlagSyncNodeNodenv, Short: "Get tool versions from nodenv", Long: "Get tool versions from nodenv"}, {Key: FlagSyncNodeNvm, Short: "Get tool versions from nvm", Long: "Get tool versions from nvm"}, - {Key: CmdSyncPython, Short: "Symlinks all tool versions from an external tool into mise", Long: "Symlinks all tool versions from an external tool into mise\n\nFor example, use this to import all pyenv installs into mise\n\nThis won't overwrite any existing installs but will overwrite any existing symlinks"}, + {Key: CmdSyncPython, Short: "Symlinks all tool versions from an external tool into mise", Long: "Symlinks all tool versions from an external tool into mise\n\nFor example, use this to import all pyenv installs into mise\n\nThis won't overwrite any existing installs but will overwrite any existing symlinks", AfterLongHelp: "Examples:\n\n $ pyenv install 3.11.0\n $ mise sync python --pyenv\n $ mise use -g python@3.11.0 - uses pyenv-provided python\n\n $ uv python install 3.11.0\n $ mise install python@3.10.0\n $ mise sync python --uv\n $ mise x python@3.11.0 -- python -V - uses uv-provided python\n $ uv run -p 3.10.0 -- python -V - uses mise-provided python\n"}, {Key: FlagSyncPythonPyenv, Short: "Get tool versions from pyenv", Long: "Get tool versions from pyenv"}, {Key: FlagSyncPythonUv, Short: "Sync tool versions with uv (2-way sync)", Long: "Sync tool versions with uv (2-way sync)"}, - {Key: CmdSyncRuby, Short: "Symlinks all ruby tool versions from an external tool into mise"}, + {Key: CmdSyncRuby, Short: "Symlinks all ruby tool versions from an external tool into mise", AfterLongHelp: "Examples:\n\n $ brew install ruby\n $ mise sync ruby --brew\n $ mise use -g ruby - Use the latest version of Ruby installed by Homebrew\n"}, {Key: FlagSyncRubyBrew, Short: "Get tool versions from Homebrew", Long: "Get tool versions from Homebrew"}, - {Key: CmdTasks, Short: "Manage tasks", VisibleAliases: []string{"t"}}, + {Key: CmdTasks, Short: "Manage tasks", VisibleAliases: []string{"t"}, AfterLongHelp: "Examples:\n\n $ mise tasks ls\n"}, {Key: FlagTasksGlobal, Short: "Only show global tasks", Long: "Only show global tasks"}, {Key: FlagTasksJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagTasksLocal, Short: "Only show non-global tasks", Long: "Only show non-global tasks"}, @@ -5654,7 +5654,7 @@ var HelpText = argv.HelpTable{ {Key: FlagTasksSortOrder, ValueName: "SORT_ORDER", ValueDemanded: true, Short: "Sort order. Default is asc.", Long: "Sort order. Default is asc.", Choices: []string{"asc", "desc"}}, {Key: FlagTasksUsage, Hide: true}, {Key: ArgTasksTask, Short: "Task name to get info of", Long: "Task name to get info of"}, - {Key: CmdTasksAdd, Short: "Create a new task", Long: "Create a new task\n\nAdds a task to the local mise.toml file.\nSee https://mise.jdx.dev/configuration.html#target-file-for-write-operations"}, + {Key: CmdTasksAdd, Short: "Create a new task", Long: "Create a new task\n\nAdds a task to the local mise.toml file.\nSee https://mise.jdx.dev/configuration.html#target-file-for-write-operations", AfterLongHelp: "Examples:\n\n $ mise tasks add pre-commit --depends \"test\" --depends \"render\" -- echo pre-commit\n"}, {Key: FlagTasksAddAlias, Repeatable: true, ValueName: "ALIAS", ValueDemanded: true, Short: "Other names for the task", Long: "Other names for the task"}, {Key: FlagTasksAddDepends, Repeatable: true, ValueName: "DEPENDS", ValueDemanded: true, Short: "Add dependencies to the task", Long: "Add dependencies to the task"}, {Key: FlagTasksAddDir, ValueName: "DIR", ValueDemanded: true, Short: "Run the task in a specific directory", Long: "Run the task in a specific directory"}, @@ -5672,22 +5672,22 @@ var HelpText = argv.HelpTable{ {Key: FlagTasksAddSilent, Short: "Do not print the command or its output", Long: "Do not print the command or its output"}, {Key: ArgTasksAddTask, Demanded: true, Short: "Tasks name to add", Long: "Tasks name to add"}, {Key: ArgTasksAddRun}, - {Key: CmdTasksDeps, Short: "Display a tree visualization of a dependency graph"}, + {Key: CmdTasksDeps, Short: "Display a tree visualization of a dependency graph", AfterLongHelp: "Examples:\n\n # Show dependencies for all tasks\n $ mise tasks deps\n\n # Show dependencies for the \"lint\", \"test\" and \"check\" tasks\n $ mise tasks deps lint test check\n\n # Show dependencies in DOT format\n $ mise tasks deps --dot\n\n # Collapse repeated dependencies\n $ mise tasks deps --compact\n"}, {Key: FlagTasksDepsCompact, Short: "Collapse repeated dependencies after their first occurrence", Long: "Collapse repeated dependencies after their first occurrence"}, {Key: FlagTasksDepsDot, Short: "Display dependencies in DOT format", Long: "Display dependencies in DOT format"}, {Key: FlagTasksDepsHidden, Short: "Show hidden tasks", Long: "Show hidden tasks"}, {Key: ArgTasksDepsTasks, Short: "Tasks to show dependencies for\nCan specify multiple tasks by separating with spaces\ne.g.: mise tasks deps lint test check", Long: "Tasks to show dependencies for\nCan specify multiple tasks by separating with spaces\ne.g.: mise tasks deps lint test check"}, - {Key: CmdTasksEdit, Short: "Edit a task with $EDITOR", Long: "Edit a task with $EDITOR\n\nThe task will be created as a standalone script if it does not already exist."}, + {Key: CmdTasksEdit, Short: "Edit a task with $EDITOR", Long: "Edit a task with $EDITOR\n\nThe task will be created as a standalone script if it does not already exist.", AfterLongHelp: "Examples:\n\n $ mise tasks edit build\n $ mise tasks edit test\n"}, {Key: FlagTasksEditPath, Short: "Display the path to the task instead of editing it", Long: "Display the path to the task instead of editing it"}, {Key: ArgTasksEditTask, Demanded: true, Short: "Task to edit", Long: "Task to edit"}, - {Key: CmdTasksGraph, Short: "[experimental] Inspect the workspace project graph"}, + {Key: CmdTasksGraph, Short: "[experimental] Inspect the workspace project graph", AfterLongHelp: "Examples:\n\n # Inspect projects and their dependency edges\n $ mise tasks graph\n\n # Emit the project graph as JSON\n $ mise tasks graph --json\n\n # Explain where inferred projects and task fields came from\n $ mise tasks graph --explain\n"}, {Key: FlagTasksGraphJson, Short: "Output the project graph as JSON", Long: "Output the project graph as JSON"}, {Key: FlagTasksGraphExplain, Short: "Explain provider attribution for inferred projects and tasks", Long: "Explain provider attribution for inferred projects and tasks"}, {Key: FlagTasksGraphNoHeader, Short: "Do not print table headers", Long: "Do not print table headers"}, - {Key: CmdTasksInfo, Short: "Get information about a task"}, + {Key: CmdTasksInfo, Short: "Get information about a task", AfterLongHelp: "Examples:\n\n $ mise tasks info\n Name: test\n Aliases: t\n Description: Test the application\n Source: ~/src/myproj/mise.toml\n\n $ mise tasks info test --json\n {\n \"name\": \"test\",\n \"aliases\": \"t\",\n \"description\": \"Test the application\",\n \"source\": \"~/src/myproj/mise.toml\",\n \"config_sources\": [\"~/src/myproj/mise.toml\"],\n \"depends\": [],\n \"env\": {},\n \"dir\": null,\n \"hide\": false,\n \"raw\": false,\n \"sources\": [],\n \"outputs\": [],\n \"run\": [\n \"echo \\\"testing!\\\"\"\n ],\n \"file\": null,\n \"usage_spec\": {}\n }\n"}, {Key: FlagTasksInfoJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: ArgTasksInfoTask, Demanded: true, Short: "Name of the task to get information about", Long: "Name of the task to get information about"}, - {Key: CmdTasksLs, Short: "List available tasks to execute\nThese may be included from the config file or from the project's .mise/tasks directory\nmise will merge all tasks from all parent directories into this list.", Long: "List available tasks to execute\nThese may be included from the config file or from the project's .mise/tasks directory\nmise will merge all tasks from all parent directories into this list.\n\nSo if you have global tasks in `~/.config/mise/tasks/*` and project-specific tasks in\n~/myproject/.mise/tasks/*, then they'll both be available but the project-specific\ntasks will override the global ones if they have the same name."}, + {Key: CmdTasksLs, Short: "List available tasks to execute\nThese may be included from the config file or from the project's .mise/tasks directory\nmise will merge all tasks from all parent directories into this list.", Long: "List available tasks to execute\nThese may be included from the config file or from the project's .mise/tasks directory\nmise will merge all tasks from all parent directories into this list.\n\nSo if you have global tasks in `~/.config/mise/tasks/*` and project-specific tasks in\n~/myproject/.mise/tasks/*, then they'll both be available but the project-specific\ntasks will override the global ones if they have the same name.", AfterLongHelp: "Examples:\n\n $ mise tasks ls\n"}, {Key: FlagTasksLsGlobal, Short: "Only show global tasks", Long: "Only show global tasks"}, {Key: FlagTasksLsJson, Short: "Output in JSON format", Long: "Output in JSON format"}, {Key: FlagTasksLsLocal, Short: "Only show non-global tasks", Long: "Only show non-global tasks"}, @@ -5700,7 +5700,7 @@ var HelpText = argv.HelpTable{ {Key: FlagTasksLsSort, ValueName: "COLUMN", ValueDemanded: true, Short: "Sort by column. Default is name.", Long: "Sort by column. Default is name.", Choices: []string{"name", "alias", "description", "source"}}, {Key: FlagTasksLsSortOrder, ValueName: "SORT_ORDER", ValueDemanded: true, Short: "Sort order. Default is asc.", Long: "Sort order. Default is asc.", Choices: []string{"asc", "desc"}}, {Key: FlagTasksLsUsage, Hide: true}, - {Key: CmdTasksRun, Short: "Run task(s)", Long: "Run task(s)\n\nThis command will run a task, or multiple tasks in parallel.\nTasks may have dependencies on other tasks or on source files.\nIf source is configured on a task, it will only run if the source\nfiles have changed.\n\nTasks can be defined in mise.toml or as standalone scripts.\nIn mise.toml, tasks take this form:\n\n [tasks.build]\n run = \"npm run build\"\n sources = [\"src/**/*.ts\"]\n outputs = [\"dist/**/*.js\"]\n\nAlternatively, tasks can be defined as standalone scripts.\nThese must be located in `mise-tasks`, `.mise-tasks`, `.mise/tasks`, `mise/tasks` or\n`.config/mise/tasks`.\nThe name of the script will be the name of the tasks.\n\n $ cat .mise/tasks/build<