# pkg-up

> Find the closest package.json file

## Install

```sh
npm install pkg-up
```

## Usage

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

```js
// example.js
import {pkgUp} from 'pkg-up';

console.log(await pkgUp());
//=> '/Users/sindresorhus/foo/package.json'
```

## API

### pkgUp(options?)

Returns a `Promise<string>` for the file path, or `Promise<undefined>` if it could not be found.

### pkgUpSync(options?)

Returns the file path, or `undefined` if it could not be found.

#### options

Type: `object`

#### cwd

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

The directory to start from.

## Related

- [read-pkg-up](https://github.com/sindresorhus/read-pkg-up) - Read the closest package.json file
- [pkg-dir](https://github.com/sindresorhus/pkg-dir) - Find the root directory of an npm package
- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories


pkg-up

pkg-up

Install

Usage

API

pkgUp(options?)

pkgUpSync(options?)

options

cwd

Keywords

FAQs

What is pkg-up?

Is pkg-up popular?

Is pkg-up well maintained?