Skip to content

Commit

Permalink
Update docs/src/content/hardhat-runner/docs/guides/command-line-compl…
Browse files Browse the repository at this point in the history
…etion.md

Co-authored-by: Patricio Palladino <[email protected]>
  • Loading branch information
iosh and alcuadrado authored Sep 14, 2024
1 parent 0fcff9d commit 7997a8e
Showing 1 changed file with 11 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,14 @@ If you are using bash, try this:

### Windows user

- The `hardhat-completion install` is not supported on Windows.
- On Windows, the default `hh` command is associated with the HTML Help executable program (Hh.exe). To use `hardhat-completion`, you can simply run `npx hh` instead of `hh`.
- If you want to set the `hh`command for hardhat-completion as the default on Windows, you can follow these steps:
1. Run the `npm config get prefix` to get the npm global packages installation location.
2. Add the npm location to the `Path` environment variable. For more information, refer to the [Microsoft document](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14))
3. You need to set the system environment variable `Path` because the `Hh.exe` is in `%SystemRoot%` environment variable. Add the npm location to the `Path` before `%SystemRoot%`
`hardhat-shothand` doesn't work well by default on Windows. Please read this to learn why and how to improve it.

On Windows, the default `hh` command is associated with the HTML Help executable program (hh.exe). To use `hardhat-shorthand`, you can simply run `npx hh` instead of `hh`, but that won't work well with its autocompletion.

If you want to use `hh` on Windows, you can follow these steps:

1. Run `npm config get prefix` to get the npm global packages installation location.

2. Add the npm location to the `Path` environment variable. For more information, refer to the [Microsoft document](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14))

3. Make sure to add the npm location to `Path` before `%SustemRoot%` because default `hh.exe` is in `%SystemRoot%`, and it will take precedence over `hh-shorthand` otherwise.

0 comments on commit 7997a8e

Please sign in to comment.