/usr/share/doc/node-pkg-dir/readme.md

# pkg-dir [![Build Status](https://travis-ci.com/sindresorhus/pkg-dir.svg?branch=master)](https://travis-ci.com/github/sindresorhus/pkg-dir)

> Find the root directory of a Node.js project or npm package

## Install

```
$ npm install pkg-dir
```

## Usage

```
/
└── Users
    └── sindresorhus
        └── foo
            ├── package.json
            └── bar
                ├── baz
                └── example.js
```

```js
// example.js
const pkgDir = require('pkg-dir');

(async () => {
        const rootDir = await pkgDir(__dirname);

        console.log(rootDir);
        //=> '/Users/sindresorhus/foo'
})();
```

## API

### pkgDir(cwd?)

Returns a `Promise` for either the project root path or `undefined` if it couldn't be found.

### pkgDir.sync(cwd?)

Returns the project root path or `undefined` if it couldn't be found.

#### cwd

Type: `string`\
Default: `process.cwd()`

Directory to start from.

## Related

- [pkg-dir-cli](https://github.com/sindresorhus/pkg-dir-cli) - CLI for this module
- [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories

---

<div align="center">
        <b>
                <a href="https://tidelift.com/subscription/pkg/npm-pkg-dir?utm_source=npm-pkg-dir&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
        </b>
        <br>
        <sub>
                Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
        </sub>
</div>

Generated by dwww version 1.15 on Thu Jun 27 23:24:02 CEST 2024.