athea
Repositories Projects Packages

pkg-dir (4.2.0)

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

Installation

registry=
npm install pkg-dir@4.2.0
"pkg-dir": "4.2.0"

About this package

pkg-dir Build Status

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 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 - 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 ^4.0.0

Development Dependencies

ID Version
ava ^1.4.1
tempy ^0.3.0
tsd ^0.7.2
xo ^0.24.0

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
latest
2.1 KiB
Assets (1)
pkg-dir-4.2.0.tgz 2.1 KiB
Versions (2) View all
3.0.0 2026-02-24
4.2.0 2026-02-24