?HAMA

Edit File Size: 1.22 KB

/home/byroehnu/.trash/node_modules11/pkg-dir/readme.md

Text Base64

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

### pkgDir.sync([cwd])

Returns the project root path or `null`.

#### 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

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
node_modules DIR	-	drwxr-xr-x	2026-02-28 00:26:18	Edit Download recursive recursive
index.js	297 B	lrw-r--r--	2026-02-28 00:26:42	Edit Download recursive recursive
license	1.08 KB	lrw-r--r--	2026-02-28 00:26:52	Edit Download recursive recursive
package.json	767 B	lrw-r--r--	2026-02-28 00:26:32	Edit Download recursive recursive
readme.md	1.22 KB	lrw-r--r--	2026-02-28 00:27:02	Edit Download recursive recursive

Directory Contents