Skip to content

docs: fix wrong positions of mise run flags#8036

Merged
jdx merged 1 commit intojdx:mainfrom
muzimuzhi:docs/run-flags
Feb 6, 2026
Merged

docs: fix wrong positions of mise run flags#8036
jdx merged 1 commit intojdx:mainfrom
muzimuzhi:docs/run-flags

Conversation

@muzimuzhi
Copy link
Contributor

@muzimuzhi muzimuzhi commented Feb 6, 2026

Also drop a mise run --changed example, which uses a non-existing --changed flag.

Copilot AI review requested due to automatic review settings February 6, 2026 19:33
@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Feb 6, 2026

Summary of Changes

Hello @muzimuzhi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the accuracy and usability of the mise run command's documentation and help messages. It rectifies instances where command-line flags were incorrectly positioned relative to task names and eliminates an example that referenced a non-existent flag, thereby improving the clarity and correctness of user guidance.

Highlights

  • Documentation Correction: Updated various documentation and help text files to correct the position of flags for the mise run command, ensuring flags are placed before the task name.
  • Invalid Example Removal: Removed an example for the mise run --changed command, as the --changed flag does not exist.
Changelog
  • docs/cli/run.md
    • Corrected mise run command examples to place flags (--force, --raw) before the task name.
  • docs/cli/tasks/run.md
    • Corrected mise run command examples to place flags (--force, --raw) before the task name.
  • docs/tasks/architecture.md
    • Updated mise run command examples to correctly position flags (--jobs, -j, --force, --verbose, --dry-run) before the task name.
    • Removed the example for mise run --changed as this flag does not exist.
  • mise.usage.kdl
    • Adjusted mise run command examples within the after_long_help sections to ensure flags (--force, --raw) are correctly placed before the task name.
  • src/cli/run.rs
    • Modified the AFTER_LONG_HELP string to correct the placement of flags (--force, --raw) in mise run command examples.
Activity
  • No specific activity (comments, reviews, etc.) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Feb 6, 2026
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request corrects the usage of mise run flags in various documentation files and help texts. The flags are now correctly placed before the task name, which aligns with the expected command-line syntax. Additionally, an example using a non-existent --changed flag has been removed. The changes are consistent across all modified files and improve the accuracy and clarity of the documentation. I find no issues with this update.

Copilot AI reviewed Feb 6, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR corrects CLI documentation/examples for mise run by placing run flags before the task name (so they’re parsed as mise options rather than task args), and removes an example using a non-existent --changed flag.

Changes:

  • Fix mise run examples to use mise run --force build, mise run --raw test, and mise run --jobs … task ordering.
  • Remove the mise run --changed example from task architecture docs.
  • Keep generated/help text examples consistent across the Rust CLI help, mise.usage.kdl, and markdown docs.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/cli/run.rs Updates the after_long_help examples to show correct flag placement before the task.
mise.usage.kdl Updates run and tasks run after_long_help examples to match correct CLI parsing.
docs/tasks/architecture.md Fixes --jobs, --force, --dry-run, --verbose ordering and removes invalid --changed example.
docs/cli/tasks/run.md Fixes example ordering for --force and --raw.
docs/cli/run.md Fixes example ordering for --force and --raw.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jdx jdx merged commit 10c9033 into jdx:main Feb 6, 2026
54 of 57 checks passed
@mise-en-dev mise-en-dev mentioned this pull request Feb 6, 2026
Merged
mise-en-dev added a commit that referenced this pull request Feb 7, 2026
@mise-en-dev
chore: release 2026.2.6 (#8027)
bafec35 
### 🚀 Features

- **(env)** add shell-style variable expansion in env values by @jdx in
[#8029](#8029)
- **(list)** add --all-sources flag to list command by @TylerHillery in
[#8019](#8019)

### 🐛 Bug Fixes

- **(gem)** Windows support for gem backend by @my1e5 in
[#8031](#8031)
- **(gem)** revert gem.rs script newline change by @my1e5 in
[#8034](#8034)
- **(lock)** write tools to lockfile matching their source config by
@jdx in [#8012](#8012)
- **(ls)** sort sources deterministically in --all-sources output by
@jdx in [#8037](#8037)
- **(task)** auto-install tools from mise.toml for file tasks by @jdx in
[#8030](#8030)

### 📚 Documentation

- fix wrong positions of `mise run` flags by @muzimuzhi in
[#8036](#8036)

### 📦️ Dependency Updates

- update ghcr.io/jdx/mise:copr docker digest to 3e00d7d by
@renovate[bot] in [#8023](#8023)
- update ghcr.io/jdx/mise:alpine docker digest to 0ced1b3 by
@renovate[bot] in [#8022](#8022)

### 📦 Registry

- add tirith
([github:sheeki03/tirith](https://github.com/sheeki03/tirith)) by
@sheeki03 in [#8024](#8024)
- add mas by @TyceHerrman in
[#8032](#8032)

### Security

- **(deps)** update time crate to 0.3.47 to fix RUSTSEC-2026-0009 by
@jdx in [#8026](#8026)

### New Contributors

- @sheeki03 made their first contribution in
[#8024](#8024)
- @TylerHillery made their first contribution in
[#8019](#8019)

## 📦 Aqua Registry Updates

#### New Packages (1)

-
[`kubernetes-sigs/kubectl-validate`](https://github.com/kubernetes-sigs/kubectl-validate)

#### Updated Packages (6)

-
[`flux-iac/tofu-controller/tfctl`](https://github.com/flux-iac/tofu-controller/tfctl)
- [`gogs/gogs`](https://github.com/gogs/gogs)
- [`j178/prek`](https://github.com/j178/prek)
- [`syncthing/syncthing`](https://github.com/syncthing/syncthing)
- [`tuist/tuist`](https://github.com/tuist/tuist)
- [`yaml/yamlscript`](https://github.com/yaml/yamlscript)
@muzimuzhi muzimuzhi deleted the docs/run-flags branch February 7, 2026 20:43
lucasew pushed a commit to lucasew/CONTRIB-mise that referenced this pull request Feb 18, 2026
@muzimuzhi @lucasew
docs: fix wrong positions of mise run flags (jdx#8036)
0e1e0e7 
Also drop a `mise run --changed` example, which uses a non-existing
`--changed` flag.
lucasew pushed a commit to lucasew/CONTRIB-mise that referenced this pull request Feb 18, 2026
@mise-en-dev @lucasew
chore: release 2026.2.6 (jdx#8027)
a10ce0e 
### 🚀 Features

- **(env)** add shell-style variable expansion in env values by @jdx in
[jdx#8029](jdx#8029)
- **(list)** add --all-sources flag to list command by @TylerHillery in
[jdx#8019](jdx#8019)

### 🐛 Bug Fixes

- **(gem)** Windows support for gem backend by @my1e5 in
[jdx#8031](jdx#8031)
- **(gem)** revert gem.rs script newline change by @my1e5 in
[jdx#8034](jdx#8034)
- **(lock)** write tools to lockfile matching their source config by
@jdx in [jdx#8012](jdx#8012)
- **(ls)** sort sources deterministically in --all-sources output by
@jdx in [jdx#8037](jdx#8037)
- **(task)** auto-install tools from mise.toml for file tasks by @jdx in
[jdx#8030](jdx#8030)

### 📚 Documentation

- fix wrong positions of `mise run` flags by @muzimuzhi in
[jdx#8036](jdx#8036)

### 📦️ Dependency Updates

- update ghcr.io/jdx/mise:copr docker digest to 3e00d7d by
@renovate[bot] in [jdx#8023](jdx#8023)
- update ghcr.io/jdx/mise:alpine docker digest to 0ced1b3 by
@renovate[bot] in [jdx#8022](jdx#8022)

### 📦 Registry

- add tirith
([github:sheeki03/tirith](https://github.com/sheeki03/tirith)) by
@sheeki03 in [jdx#8024](jdx#8024)
- add mas by @TyceHerrman in
[jdx#8032](jdx#8032)

### Security

- **(deps)** update time crate to 0.3.47 to fix RUSTSEC-2026-0009 by
@jdx in [jdx#8026](jdx#8026)

### New Contributors

- @sheeki03 made their first contribution in
[jdx#8024](jdx#8024)
- @TylerHillery made their first contribution in
[jdx#8019](jdx#8019)

## 📦 Aqua Registry Updates

#### New Packages (1)

-
[`kubernetes-sigs/kubectl-validate`](https://github.com/kubernetes-sigs/kubectl-validate)

#### Updated Packages (6)

-
[`flux-iac/tofu-controller/tfctl`](https://github.com/flux-iac/tofu-controller/tfctl)
- [`gogs/gogs`](https://github.com/gogs/gogs)
- [`j178/prek`](https://github.com/j178/prek)
- [`syncthing/syncthing`](https://github.com/syncthing/syncthing)
- [`tuist/tuist`](https://github.com/tuist/tuist)
- [`yaml/yamlscript`](https://github.com/yaml/yamlscript)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@muzimuzhi @jdx