Skip to content

docs(agents): document mise CLI setup - #8202

Open
lavoiesl wants to merge 4 commits into
mainfrom
seb-mise
Open

docs(agents): document mise CLI setup#8202
lavoiesl wants to merge 4 commits into
mainfrom
seb-mise

Conversation

@lavoiesl

@lavoiesl lavoiesl commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Jira

https://coveord.atlassian.net/browse/KIT-6038

Motivation

Coding agents need a clear, repository-specific way to initialize the managed CLI toolchain. The previous guidance referenced nvm and corepack even though this repository uses mise.

Changes

  • Document mise.toml as the source of truth for the CLI toolchain.
  • Instruct agents to verify mise is installed and run mise install before using repository CLI tools.
  • Prevent fallback to nvm, corepack, npx, or npm for the repository toolchain.
  • Correct the inline-code formatting for the AWS CLI reference.

Validation

  • pnpm run lint:fix
  • Pre-commit hooks passed, including cspell for AGENTS.md.

Checklist

  • PR title follows Conventional Commits format (docs(agents): <description>)
  • No changeset required because this is documentation-only and does not affect a public package API.

Make mise the documented source of truth for repository CLI tools and guide agents through the required environment setup.
@changeset-bot

changeset-bot Bot commented Aug 10, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 639f2c8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@svcsnykcoveo

svcsnykcoveo commented Aug 10, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@pkg-pr-new

pkg-pr-new Bot commented Aug 10, 2026

Copy link
Copy Markdown
@coveo/atomic

npm i https://pkg.pr.new/@coveo/atomic@8202

@coveo/atomic-hosted-page

npm i https://pkg.pr.new/@coveo/atomic-hosted-page@8202

@coveo/atomic-legacy

npm i https://pkg.pr.new/@coveo/atomic-legacy@8202

@coveo/atomic-react

npm i https://pkg.pr.new/@coveo/atomic-react@8202

@coveo/auth

npm i https://pkg.pr.new/@coveo/auth@8202

@coveo/bueno

npm i https://pkg.pr.new/@coveo/bueno@8202

@coveo/create-atomic

npm i https://pkg.pr.new/@coveo/create-atomic@8202

@coveo/create-atomic-component

npm i https://pkg.pr.new/@coveo/create-atomic-component@8202

@coveo/create-atomic-component-project

npm i https://pkg.pr.new/@coveo/create-atomic-component-project@8202

@coveo/create-atomic-result-component

npm i https://pkg.pr.new/@coveo/create-atomic-result-component@8202

@coveo/create-atomic-rollup-plugin

npm i https://pkg.pr.new/@coveo/create-atomic-rollup-plugin@8202

@coveo/create-ui

npm i https://pkg.pr.new/@coveo/create-ui@8202

@coveo/headless

npm i https://pkg.pr.new/@coveo/headless@8202

@coveo/headless-react

npm i https://pkg.pr.new/@coveo/headless-react@8202

@coveo/relay

npm i https://pkg.pr.new/@coveo/relay@8202

@coveo/shopify

npm i https://pkg.pr.new/@coveo/shopify@8202

commit: 639f2c8

@lavoiesl
lavoiesl marked this pull request as ready for review August 10, 2026 18:14
@lavoiesl
lavoiesl requested review from a team, fbeaudoincoveo, jfcere-coveo and y-lakhdar and a lite review from Copilot August 10, 2026 18:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the repo’s agent-facing tooling documentation and mise configuration so contributors initialize the CLI toolchain via mise.toml instead of nvm/corepack.

Changes:

  • Document mise as the required toolchain manager in AGENTS.md and forbid nvm/corepack/npx/npm.
  • Adjust mise.toml to enable idiomatic version files and make installs reproducible via pnpm install --frozen-lockfile.

Reviewed changes

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

File Description
mise.toml Switches toolchain configuration approach and tightens the install task to use a frozen lockfile.
AGENTS.md Updates agent prerequisites to use mise and removes prior nvm/corepack guidance.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread mise.toml
Comment thread AGENTS.md Outdated
Comment on lines +8 to +10
1. If `mise` is not installed, stop and ask the user to install it with `brew install mise`. Do not do it for them.
2. Run `mise install`
3. Export all the env vars as given by `mise env`

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I specifically don't want to use eval because that trips most security checks

Clarified instructions for exporting environment variables.
Comment thread AGENTS.md
Before using `aws`, `pnpm` or `node`:
1. If `mise` is not installed, stop and ask the user to install it with `brew install mise`. Do not do it for them.
2. Run `mise install`
3. `export` all the env vars as given by `mise env` in the current shell for the next command invocations. Notably, this will override `PATH`.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

There are 2 recommended ways:

  • eval "$(mise activate)"
  • eval "$(mise activate --shims)"

--shims is much simpler:

export PATH="/Users/slavoie2/.local/share/mise/shims:$PATH"

However, both need eval, and harness really don't like that, routinely blocking the execution.


Adding ~/.local/share/mise/shims to PATH could work, but:

  • It feels brittle to manipulate the PATH directly and assuming some things about the environments
  • shims change the resolved path of tools, sometimes creating other problems with path-based allow/blocklists
$ ls -l ~/.local/share/mise/shims
total 0
lrwxr-xr-x@ 1 slavoie2  staff  22 Aug 10 13:57 aws -> /opt/homebrew/bin/mise
lrwxr-xr-x@ 1 slavoie2  staff  22 Aug 10 13:57 aws_completer -> /opt/homebrew/bin/mise
lrwxr-xr-x@ 1 slavoie2  staff  22 Aug  7 09:54 corepack -> /opt/homebrew/bin/mise
lrwxr-xr-x@ 1 slavoie2  staff  22 Aug  7 09:54 node -> /opt/homebrew/bin/mise
lrwxr-xr-x@ 1 slavoie2  staff  22 Aug  7 09:54 npm -> /opt/homebrew/bin/mise
lrwxr-xr-x@ 1 slavoie2  staff  22 Aug  7 09:54 npx -> /opt/homebrew/bin/mise
lrwxr-xr-x@ 1 slavoie2  staff  22 Aug  7 09:54 pnpm -> /opt/homebrew/bin/mise

I tested this solution in Kiro and it works well.

I encourage reviewers to test before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants