docs: added troubleshooting section for cli tool (#2357)

docs/content/advanced/backend/plugins/create.md

@@ -10,6 +10,12 @@ This guide uses the Medusa CLI throughout different steps. If you don’t have t
 npm install @medusajs/medusa-cli -g
 ```
 
+:::note
+
+If you run into any errors while installing the CLI tool, check out the [troubleshooting guide](../../../troubleshooting/cli-installation-errors.mdx).
+
+:::
+
 ## Initialize Project
 
 The recommended way to create a plugin is using the Medusa CLI. Run the following command to create a new Medusa project:

docs/content/cli/reference.md

@@ -16,6 +16,12 @@ To install the CLI tool, run the following command in your terminal:
 npm install @medusajs/medusa-cli -g
 ```
 
+:::note
+
+If you run into any errors while installing the CLI tool, check out the [troubleshooting guide](../troubleshooting/cli-installation-errors.mdx).
+
+:::
+
 The CLI tool is then available under the `medusa` command. You can see all commands and options with the following command:
 
 ```bash

docs/content/quickstart/quick-start.md

@@ -22,7 +22,7 @@ You can install Node from the [official website](https://nodejs.org/en/).
 
 :::note
 
-If you get a permission error when using NPM, check out [NPM's documentation for a solution](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).
+If you run into any errors while installing the CLI tool, check out the [troubleshooting guide](../troubleshooting/cli-installation-errors.mdx).
 
 :::
 

docs/content/troubleshooting/cli-installation-errors.mdx

@@ -0,0 +1,47 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Resolve Errors Installing Medusa CLI
+
+In this document, you can find solutions to some common problems that occur when installing Medusa’s CLI Tool.
+
+## NPM Error: EACCES Permissions Errors
+
+If you install the Medusa CLI tool with NPM and get a permission error, NPM proposes as a solution either re-installing NPM with a node version manager (nvm), or manually setting npm’s default directory.
+
+You can check out more information in [NPM’s documentation](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).
+
+<!-- vale off -->
+
+## Yarn Error: command not found: medusa
+
+<!-- vale on -->
+
+If you install the Medusa CLI tool with Yarn, then try to use the CLI tool but get the error:
+
+```bash
+command not found: medusa
+```
+
+You have to add Yarn’s install location to the PATH variable:
+
+<Tabs groupId="operating-systems">
+<TabItem value="unix" label="MacOS / Linux" default>
+
+```bash
+export PATH="$(yarn global bin):$PATH"
+```
+
+</TabItem>
+<TabItem value="windows" label="Windows">
+
+```bash
+# MAKE SURE TO INCLUDE %path%
+setx path "%path%;c:\users\YOURUSERNAME\appdata\local\yarn\bin"
+# YOURUSERNAME is your account username
+```
+
+</TabItem>
+</Tabs>
+
+You can learn more in [Yarn’s documentation](https://classic.yarnpkg.com/en/docs/cli/global#adding-the-install-location-to-your-path).

docs/content/tutorial/0-set-up-your-development-environment.mdx

@@ -136,6 +136,12 @@ You can install Medusa’s CLI with the following command:
 npm install @medusajs/medusa-cli -g
 ```
 
+:::note
+
+If you run into any errors while installing the CLI tool, check out the [troubleshooting guide](../troubleshooting/cli-installation-errors.mdx).
+
+:::
+
 ## Optional Tools
 
 These tools are not required to have to run a Medusa server, but it's highly recommended that you have them installed.