Skip to content

WHERE PATH? WHAT PATH? WHERE DESCRIPTION IN DOCUMENTATION???? #7482

@andriiv-pri

Description

@andriiv-pri

Version

5.0.9

Reproduction link

github.com/vuejs/vue-cli

Environment info

Short summary
-------------
After running `yarn global add @vue/cli` (or `npm install -g @vue/cli`) on macOS with zsh, the `vue` command is often not found (`zsh: command not found: vue`). The Getting Started docs only show the global install command but don't tell users where the binary is installed or how to add it to PATH. This causes a lot of confusion.

Steps to reproduce
------------------
1. On macOS with zsh:
   - `yarn global add @vue/cli`
   - Close terminal / open new terminal
2. Run:
   - `vue --version`
   - Or `vue create my-project`

Observed behavior
-----------------
- `zsh: command not found: vue`
- The docs currently give no guidance about `yarn global bin` locations or how to update common shells (zsh, bash, fish).

Expected behavior in docs
-------------------------
Docs should include:
1. How to find the global bin:
   - `yarn global bin`
   - `npm bin -g`
   - Typical locations: e.g. `/Users/<user>/.yarn/bin`, `/Users/<user>/.config/yarn/global/node_modules/.bin`, or `/usr/local/bin` for npm.
2. Example of how to add the global bin to the PATH for common shells (zsh example):
   ```bash
   echo 'export PATH="$(yarn global bin):$PATH"' >> ~/.zshrc
   source ~/.zshrc

Steps to reproduce

Short summary

After running yarn global add @vue/cli (or npm install -g @vue/cli) on macOS with zsh, the vue command is often not found (zsh: command not found: vue). The Getting Started docs only show the global install command but don't tell users where the binary is installed or how to add it to PATH. This causes a lot of confusion.

Steps to reproduce

  1. On macOS with zsh:
    • yarn global add @vue/cli
    • Close terminal / open new terminal
  2. Run:
    • vue --version
    • Or vue create my-project

Observed behavior

  • zsh: command not found: vue
  • The docs currently give no guidance about yarn global bin locations or how to update common shells (zsh, bash, fish).

Expected behavior in docs

Docs should include:

  1. How to find the global bin:
    • yarn global bin
    • npm bin -g
    • Typical locations: e.g. /Users/<user>/.yarn/bin, /Users/<user>/.config/yarn/global/node_modules/.bin, or /usr/local/bin for npm.
  2. Example of how to add the global bin to the PATH for common shells (zsh example):
    echo 'export PATH="$(yarn global bin):$PATH"' >> ~/.zshrc
    source ~/.zshrc
    
    

What is expected?

created project

What is actually happening?

the vue command is often not found (zsh: command not found: vue)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions