# global-modules-path

> Returns path to globally installed package

Latest version **3.0.0** (published 2023-01-08) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install global-modules-path
pnpm add global-modules-path
yarn add global-modules-path
bun add global-modules-path
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2023-01-08 |
| First published | 2016-11-01 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | separate (@types/global-modules-path) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Rosen Vladimirov |
| Maintainers | rosen_vladimirov, rosen-vladimirov, tsvetie |
| Keywords | npm, global, installed, path |

## Links

- npm: https://www.npmjs.com/package/global-modules-path
- Repository: https://github.com/rosen-vladimirov/global-modules-path
- Homepage: https://github.com/rosen-vladimirov/global-modules-path#readme
- Issues: https://github.com/rosen-vladimirov/global-modules-path/issues
- npm.io page: https://npm.io/package/global-modules-path

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 3.0.0 (latest) — 2023-01-08
- 2.3.1 — 2018-11-30
- 2.3.0 — 2018-07-20
- 2.2.0 — 2018-07-19
- 2.1.0 — 2018-03-22
- 2.0.0 — 2017-06-29
- 1.0.0 — 2016-11-01

## README

# global-modules-path
Returns path to globally installed package.

## System requirements
In order to use this package you need:
 - Node.js 4.0.0 or later
 - npm 2.0.0 or later added to your PATH environment variable (you should be able to execute `npm --version` from your default terminal).

## Usage
The module has a single public method called `getPath`. It requires at least one argument - the name of the globally installed package that you need.
In case the package is not installed, `getPath` will return null.
`getPath` will throw error in case the OS is **NOT** supported. Supported OS are:
 - Windows (`process.platform` returns `win32`)
 - macOS (`process.platform` returns `darwin`)
 - Linux (`process.platform` returns `linux`)

### Using getPath with single argument
Example:
```
let pathToPackage = require("global-modules-path").getPath("packageName");
```

The method returns the path to globally installed package or null. The code constructs the path based on the result of `npm config get prefix` and checks if the package exists.

### Using getPath with package name and executable name.
Example:
```
let pathToPackage = require("global-modules-path").getPath("packageName", "executableName");
```
The method returns the path to globally installed package or null. The code constructs the path based on the result of `npm config get prefix` and checks if the package exists. In case the package cannot be found in this way, the `executableName` is used to determine if the package is globally installed.
- On Windows the package spawns `where executableName` command and parses the result.
- On macOS and Linux the package spawns `ls -l executableName` and `which executableName` and parses the results.

>NOTE: In some cases the executable name is not the same as the package name.

---
_Source: https://npm.io/package/global-modules-path · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._