File Manager

Current Path: Root / node_modules/ pkg-dir

Parent Directory

Name	Size	Last Modified
[D]node_modules/	-	2022-10-08 17:28:14
[F]index.d.ts	1.04 KB	2022-10-08 17:28:19
[F]index.js Edit	452 bytes	2022-10-08 17:28:19
[F]license	1.08 KB	2022-10-08 17:28:19
[F]package.json Edit	841 bytes	2022-10-08 17:28:18
[F]readme.md Edit	1.25 KB	2022-10-08 17:28:19

Editing: readme.md

# pkg-dir [![Build Status](https://travis-ci.org/sindresorhus/pkg-dir.svg?branch=master)](https://travis-ci.org/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`<br>
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

## License

Cancel

File Explorer

Navigation

File Manager

Editing: readme.md

File Explorer

Navigation

File Manager

Editing: readme.md

Confirm Deletion

Rename Item

Change Permissions (Chmod)