athea

Repositories Projects Packages

pkg-dir (3.0.0)

Published 2026-02-24 14:02:41 +00:00 by atheaadmin

Installation

Setup this registry in your project .npmrc file:

registry=

To install the package using npm, run the following command:

npm install pkg-dir@3.0.0

or add it to the package.json file:

"pkg-dir": "3.0.0"

For more information on the npm registry, see the documentation.

About this package

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

// 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 null if it couldn't be found.

pkgDir.sync([cwd])

Returns the project root path or null.

cwd

Type: string
Default: process.cwd()

Directory to start from.

Related

• pkg-dir-cli - CLI for this module
• pkg-up - Find the closest package.json file
• find-up - Find a file by walking up parent directories

License

MIT © Sindre Sorhus

Dependencies

Dependencies

ID	Version
find-up	^3.0.0

Development Dependencies

ID	Version
ava	*
xo	*

Keywords

package json root npm entry find up find-up findup look-up look file search match resolve parent parents folder directory dir walk walking path

Details

npm

2026-02-24 14:02:41 +00:00

0

Sindre Sorhus

Project Site

MIT

1.8 KiB

Assets (1)

pkg-dir-3.0.0.tgz 1.8 KiB

Versions (2) View all

3.0.0 2026-02-24

4.2.0 2026-02-24