open-index/open-npm huggingface dataset:
npm package: @pkg-stats/cli
Description: pkg-stats-cli
Author: malei0311
Latest version: 1.1.0

# @pkg-stats/cli

## install

```bash
npm install -g @pkg-stats/cli
```

## usage

```bash
pkg-stats downloads -h
Usage: pkg-stats downloads [options] <packageName...>

npm package stats: downloads

Arguments:
  packageName                    must have a package name

Options:
  -s, --startDate <date>         must have a start date, format: YYYY-MM-DD
  -e, --endDate <date>           must have a end date, format: YYYY-MM-DD
  -p, --urlPrefixes [prefix...]  must have a format
  -m, --merge                    is merge prefix
  -h, --help                     display help for command
```

## example

```bash
pkg-stats downloads react react-dom
```

output:

![stats-downloads](../../docs/assets/pkg-stats-downloads.jpg)
npm package: @pkg-tools/build
Description: A utility/tool for building packages
Latest version: 1.0.2

# @pkg-tools/build

> A build tool with typed configuration.

[![@pkg-tools/build::version][build-version-src]][build-version-href] [![@pkg-tools/build::downloads][build-downloads-src]][build-downloads-href]

This tool is a thin abstraction on top of [unbuild](https://github.com/unjs/unbuild). It centralizes your build configuration, which helps us consistently build opensource packages that support both module systems (CJS and ESM).

## Install

```bash
# w/ pnpm
pnpm add -D @pkg-tools/build @pkg-tools/config

# w/ yarn
yarn add -D @pkg-tools/build @pkg-tools/config

# w/ npm
npm install -D @pkg-tools/build @pkg-tools/config
```

## Usage

In your `package.json`, you can use the exported cli `build` in your build script e.g.

```
"scripts": {
  "build": "build"
  "dev": "build -w"
  "stub": "build -s"
}
```

## Configure

Define a `pkg.config.ts` in the root of your package and add the following.

```ts
import { defineConfig } from "@pkg-tools/config";

export default defineConfig({
  build: {
    entries: ["src/index"],
    sourcemap: true,
    extensions: "compatible",
    rollup: {
      inlineDependencies: true,
      emitCJS: true,
      esbuild: {
        target: ["node16"],
        minify: true,
      },
    },
    declaration: "compatible",
  },
});
```

## License

[MIT](./LICENSE)

[build-version-src]: https://img.shields.io/npm/v/%40pkg-tools/build?style=flat-square
[build-version-href]: https://npmjs.com/package/%40pkg-tools/build
[build-downloads-src]: https://img.shields.io/npm/dm/%40pkg-tools/build?style=flat-square
[build-downloads-href]: https://npmjs.com/package/%40pkg-tools/build
npm package: @pkg-tools/clean
Description: A utility/tool for cleaning packages
Latest version: 1.0.1

# @pkg-tools/clean

> A build artifact cleaning tool with typed configuration.

[![@pkg-tools/clean::version][clean-version-src]][clean-version-href]
[![@pkg-tools/clean::downloads][clean-downloads-src]][clean-downloads-href]

This CLI is a thin abstraction on top of [ShellJs](https://www.npmjs.com/package/shelljs). It centralizes our usage of ShellJS's `rm` command.

## Install

```bash
# w/ pnpm
pnpm add -D @pkg-tools/clean @pkg-tools/config

# w/ yarn
yarn add -D @pkg-tools/clean @pkg-tools/config

# w/ npm
npm install -D @pkg-tools/clean @pkg-tools/config
```

## Usage

In your `package.json`, you can use the exported cli `clean` in your clean script e.g.

```
"scripts": {
  "clean": "clean"
}
```

## Configure

Define a `pkg.config.ts` in the root of your package and add the following.

```ts
import { defineConfig } from '@pkg-tools/config';

export default defineConfig({
  clean: {
    directory: './dist',
  },
});
```

## License

[MIT](./LICENSE)

[clean-version-src]: https://img.shields.io/npm/v/%40pkg-tools/clean?style=flat-square
[clean-version-href]: https://npmjs.com/package/%40pkg-tools/clean
[clean-downloads-src]: https://img.shields.io/npm/dm/%40pkg-tools/clean?style=flat-square
[clean-downloads-href]: https://npmjs.com/package/%40pkg-tools/clean
npm package: @pkg-tools/config
Description: A unified configuration layer for pkg-tools
Latest version: 1.0.8

# @pkg-tools/config

> A package used to configure your pkg-tools usage

[![@pkg-tools/config::version][config-version-src]][config-version-href]
[![@pkg-tools/config::downloads][config-downloads-src]][config-downloads-href]

This package is meant to be used in tandem with other pkg-tools packages. It provides a function `defineConfig` for defining your pkg-tools configuration.

## Install

```bash
# w/ pnpm
pnpm add -D @pkg-tools/config

# w/ yarn
yarn add -D  @pkg-tools/config

# w/ npm
npm install -D @pkg-tools/config
```

## Usage

Define a `pkg.config.ts` in the root of your package and add the following.

```ts
import { defineConfig } from '@pkg-tools/config';

export default defineConfig({
  config: {
    directory: './dist',
  },
});
```

## License

[MIT](./LICENSE)

[config-version-src]: https://img.shields.io/npm/v/%40pkg-tools/config?style=flat-square
[config-version-href]: https://npmjs.com/package/%40pkg-tools/config
[config-downloads-src]: https://img.shields.io/npm/dm/%40pkg-tools/config?style=flat-square
[config-downloads-href]: https://npmjs.com/package/%40pkg-tools/config
npm package: @pkg-tools/create-pkg
Description: A utility for creating packages that use pkg-tools
Latest version: 0.0.6

# @pkg-tools/create-pkg

> A CLI for scaffolding packages w/ pkg-tools

## Usage

```sh
# pnpm
pnpm create @pkg-tools/pkg

# Yarn
yarn create @pkg-tools/pkg

# npm
npm create @pkg-tools/pkg
```

And then follow the instructions printed in your terminal.

You can specify the path to initialize the example project and the template to use by running:

```sh
# pnpm
pnpm create @pkg-tools/pkg -- --path=path-to-package --template=template-name

# Yarn
yarn create @pkg-tools/pkg -- --path=path-to-package --template=template-name

# npm
npm create @pkg-tools/pkg -- --path=path-to-package --template=template-name
```

## Templates

See the [`templates`](./templates) directory for the list of templates.

- [`node`](./templates/node)
- [`cli`](./templates/cli)
- [`react`](./templates/react)

## License

[MIT](./LICENSE)
npm package: @pkg-tools/format
Description: A utility/tool for formating packages
Latest version: 1.0.5

# @pkg-tools/format

> A code formatting tool with typed configuration.

[![@pkg-tools/format::version][format-version-src]][format-version-href]
[![@pkg-tools/format::downloads][format-downloads-src]][format-downloads-href]

This CLI is a thin abstraction on top of [prettier](https://prettier.io/).

## Install

```bash
# w/ pnpm
pnpm add -D @pkg-tools/format @pkg-tools/config

# w/ yarn
yarn add -D @pkg-tools/format @pkg-tools/config

# w/ npm
npm install -D @pkg-tools/format @pkg-tools/config
```

## Usage

In your `package.json`, you can use the exported cli `format` in your format script e.g.

```
"scripts": {
  "format": "format"
  "format:check": "format -c"
}
```

## Configure

Define a `pkg.config.ts` in the root of your package and add the following.

```ts
import { defineConfig } from '@pkg-tools/config';

export default defineConfig({
  format: {
    semi: true,
    tabWidth: 2,
    singleQuote: true,
  },
});
```

Since @pkg-tools/format leverages [prettier](https://prettier.io/), you'll still need to create a prettier configuration file for @pkg-tools/format to work in your editor.

To do so create a file named `.prettierrc.cjs` with the following contents in the root of your package.

```js
const { getConfig } = require('@pkg-tools/format/config');
module.exports = getConfig();
```

## License

[MIT](./LICENSE)

[format-version-src]: https://img.shields.io/npm/v/%40pkg-tools/format?style=flat-square
[format-version-href]: https://npmjs.com/package/%40pkg-tools/format
[format-downloads-src]: https://img.shields.io/npm/dm/%40pkg-tools/format?style=flat-square
[format-downloads-href]: https://npmjs.com/package/%40pkg-tools/format
npm package: @pkg-tools/lint
Description: A utility/tool for linting packages
Latest version: 1.0.7

# @pkg-tools/lint

> A code linting tool with typed configuration.

[![@pkg-tools/lint::version][lint-version-src]][lint-version-href]
[![@pkg-tools/lint::downloads][lint-downloads-src]][lint-downloads-href]

This CLI is a thin abstraction on top of [eslint](https://eslint.org/).

## Install

```bash
# w/ pnpm
pnpm add -D @pkg-tools/lint @pkg-tools/config

# w/ yarn
yarn add -D @pkg-tools/lint @pkg-tools/config

# w/ npm
npm install -D @pkg-tools/lint @pkg-tools/config

```

## Usage

In your `package.json`, you can use the exported cli `lint` in your lint script e.g.

```
"scripts": {
  "lint": "lint"
}
```

## Configure

Define a `pkg.config.ts` in the root of your package and add the following.

```ts
import { defineConfig } from '@pkg-tools/config';

export default defineConfig({
  lint: {
    rules: {
      'no-unused-vars': 0,
    },
  },
});
```

Since @pkg-tools/lint leverage [eslint](https://eslint.org/), you'll still need to create a eslint configuration file for @pkg-tools/lint to work in your editor.

To do so create a file named `.eslintrc.cjs` with the following contents in the root of your package.

```js
const { getConfig } = require('@pkg-tools/lint/config');
module.exports = getConfig();
```

## License

[MIT](./LICENSE)

[lint-version-src]: https://img.shields.io/npm/v/%40pkg-tools/lint?style=flat-square
[lint-version-href]: https://npmjs.com/package/%40pkg-tools/lint
[lint-downloads-src]: https://img.shields.io/npm/dm/%40pkg-tools/lint?style=flat-square
[lint-downloads-href]: https://npmjs.com/package/%40pkg-tools/lint
npm package: @pkg-tools/sync
Description: A utility/tool for syncing packages
Latest version: 0.2.1

# @pkg-tools/sync

🚧 This package is in beta. 🚧

> A code mirroring tool with typed configuration.

[![@pkg-tools/sync::version][sync-version-src]][sync-version-href]
[![@pkg-tools/sync::downloads][sync-downloads-src]][sync-downloads-href]

A CLI for mirroring code from a package in a monorepo to another repository.

## Install

```bash
# w/ pnpm
pnpm add -D @pkg-tools/sync @pkg-tools/config

# w/ yarn
yarn add -D @pkg-tools/sync @pkg-tools/config

# w/ npm
npm install -D @pkg-tools/sync @pkg-tools/config

```

## Usage

In your `package.json`, you can use the exported cli `sync` in your sync script e.g.

```
"scripts": {
  "sync": "sync"
}
```

## Configure

Define a `pkg.config.ts` in the root of your package and add the following.

```ts
import { defineConfig } from "@pkg-tools/config";

export default defineConfig({
  sync: {
    //TBD
  },
});
```

## License

[MIT](./LICENSE)

[sync-version-src]: https://img.shields.io/npm/v/%40pkg-tools/sync?style=flat-square
[sync-version-href]: https://npmjs.com/package/%40pkg-tools/sync
[sync-downloads-src]: https://img.shields.io/npm/dm/%40pkg-tools/sync?style=flat-square
[sync-downloads-href]: https://npmjs.com/package/%40pkg-tools/sync
npm package: @pkg-tools/utilities
Description: A set of utilities used by @pkg-tools/*
Latest version: 1.0.1

# @pkg-tools/utilities

> An internal package housing utilites used by @pkg-tools/\*

[![@pkg-tools/utilities::version][utilities-version-src]][utilities-version-href]
[![@pkg-tools/utilities::downloads][utilities-downloads-src]][utilities-downloads-href]

## Install

```bash
# w/ pnpm
pnpm add -D @pkg-tools/utilities

# w/ yarn
yarn add -D @pkg-tools/utilities

# w/ npm
npm install -D @pkg-tools/utilities
```

## Usage

Meant for internal usage only.

## License

[MIT](./LICENSE)

[utilities-version-src]: https://img.shields.io/npm/v/%40pkg-tools/utilities?style=flat-square
[utilities-version-href]: https://npmjs.com/package/%40pkg-tools/utilities
[utilities-downloads-src]: https://img.shields.io/npm/dm/%40pkg-tools/utilities?style=flat-square
[utilities-downloads-href]: https://npmjs.com/package/%40pkg-tools/utilities``
npm package: @pkgai/fetch-sse
Description: <!-- automd:badges color="orange" license licenseBranch  bundlephobia packagephobia name="@pkgai/fetch-sse" -->
Author: whitekite
Latest version: 0.0.3

# @pkgai/fetch-sse

<!-- automd:badges color="orange" license licenseBranch  bundlephobia packagephobia name="@pkgai/fetch-sse" -->

[![npm version](https://img.shields.io/npm/v/@pkgai/fetch-sse?color=orange)](https://npmjs.com/package/@pkgai/fetch-sse)
[![npm downloads](https://img.shields.io/npm/dm/@pkgai/fetch-sse?color=orange)](https://npm.chart.dev/@pkgai/fetch-sse)
[![bundle size](https://img.shields.io/bundlephobia/minzip/@pkgai/fetch-sse?color=orange)](https://bundlephobia.com/package/@pkgai/fetch-sse)
[![install size](https://badgen.net/packagephobia/install/@pkgai/fetch-sse?color=orange)](https://packagephobia.com/result?p=@pkgai/fetch-sse)
[![license](https://img.shields.io/github/license/pkgai/sse-kit?color=orange)](https://github.com/pkgai/sse-kit/blob/true/LICENSE)

<!-- /automd -->

[EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) `fetch` 实现版

## 安装

<!-- automd:pm-install name="@pkgai/fetch-sse" -->

```sh
# ✨ Auto-detect
npx nypm install @pkgai/fetch-sse

# npm
npm install @pkgai/fetch-sse

# yarn
yarn add @pkgai/fetch-sse

# pnpm
pnpm install @pkgai/fetch-sse

# bun
bun install @pkgai/fetch-sse

# deno
deno install @pkgai/fetch-sse
```

<!-- /automd -->

## 简单使用

```ts
import { fetch } from '@pkgai/fetch-sse'

const response = await fetch('https://openai-like/v1/chat/completions',{
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {API_KEY}',
  },
  body: JSON.stringify({
    model: 'qwq-32b',
    messages: [
      {
        role: 'user',
        content: '9.9和9.11谁大',
      },
    ],
    stream: true,
    stream_options: {
      include_usage: true,
    },
  })
})

for await (const chunk of response) {
  console.log(chunk)
  // data: 
  console.log(chunk.data)
  // event:
  console.log(chunk.event)
}
```

## 贡献者
<!-- automd:contributors author="Colourlessglow" license="MIT"  -->

Published under the [MIT](https://github.com/pkgai/sse-kit/blob/main/LICENSE) license.
Made by [@Colourlessglow](https://github.com/Colourlessglow) and [community](https://github.com/pkgai/sse-kit/graphs/contributors) 💛
<br><br>
<a href="https://github.com/pkgai/sse-kit/graphs/contributors">
<img src="https://contrib.rocks/image?repo=pkgai/sse-kit" />
</a>

<!-- /automd -->

<!-- automd:with-automd -->

---

_🤖 auto updated with [automd](https://automd.unjs.io)_

<!-- /automd -->
npm package: @pkgdeps/checksum-collector
Description: Collection checking checksum operations in shellscript.
Author: azu
Latest version: 1.3.1

# @pkgdeps/checksum-collector

Collection checking checksum operations in shellscript.

## Overview

1. Collect `chmod +x {binary}`
2. Check if The `{binary}` is verified with checksum checker like `shasum` or `md5sum` etc
3. Return the collected results

## Install

Install with [npm](https://www.npmjs.com/):

    npm install @pkgdeps/checksum-collector

## Usage

- [ ] Write usage instructions

## Changelog

See [Releases page](https://github.com/pkgdeps/unverified-checksum-checker/releases).

## Running tests

Install devDependencies and Run `npm test`:

    npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/pkgdeps/unverified-checksum-checker/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- azu: [GitHub](https://github.com/azu), [Twitter](https://twitter.com/azu_re)

## License

MIT © azu
npm package: @pkgdeps/secretlint-rule-checksum
Description: secretlint rule that check if checking checksum.
Author: azu
Latest version: 1.3.1

# @pkgdeps/secretlint-rule-checksum

[secretlint](https://github.com/secretlint/secretlint) rule that check if checking checksum.

## Install

Install with [npm](https://www.npmjs.com/):

    npm install @pkgdeps/secretlint-rule-checksum

Requirements: [secretlint](https://github.com/secretlint/secretlint) v4+

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@pkgdeps/secretlint-rule-checksum"
        }
    ]
}
```

## MessageIDs

### FOUND_UNVERIFIED_BINARY
> found unverified binary: ${props.binary}

You need to verify checksum of the executable binary.

This rule found a unverified binary.
Unverified binary is next definition.

- Do `chmod +x binary`
- And the binary is not verified by `checksum` command

This rule aims to found untrusted binary that is downloaded by `curl` or `wget`.
As a results, It will prevent Supply-chain attack via untrusted binary.

verify-checksum-cheatsheet helps you how to verify the binary.

- [pkgdeps/verify-checksum-cheatsheet: Checksum CheatSheet. You need to verify the checksum before executing the downloaded binary.](https://github.com/pkgdeps/verify-checksum-cheatsheet)

## Manual Verify

This rule report some false-positive, So You can verify the binary by comment.

This rule ignore the error if following comment is found around `chmod`.

```shell
# {binary} is verified
```

For example, You can verify the `jq` binary by a comment.

```shell
# jq is verified
chmod 755 jq
```

or 

```shell
chmod 755 jq # jq is verified
```

## Options

- `allowBinaryNames: string[]`
    - Allows a list of binary name
    - For example, `["jq"]`

## Changelog

See [Releases page](https://github.com/secretlint/secretlint/releases).

## Changelog

See [Releases page](https://github.com/pkgdeps/unverified-checksum-checker/releases).

## Running tests

Install devDependencies and Run `npm test`:

    npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/pkgdeps/unverified-checksum-checker/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- azu: [GitHub](https://github.com/azu), [Twitter](https://twitter.com/azu_re)

## License

MIT © azu
npm package: @pkgdeps/unverified-checksum-checker
Description: A command line tool that check if checking checksum in shellscript.
Author: azu
Latest version: 1.3.1

# @pkgdeps/unverified-checksum-checker

A command line tool that check if checking checksum in shellscript.

## Install

Install with [npm](https://www.npmjs.com/):

    npm install @pkgdeps/unverified-checksum-checker --global

## Usage

    Usage
      $ npx @pkgdeps/unverified-checksum-checker [file|glob]
 
    Options

    Examples
      $ npx @pkgdeps/unverified-checksum-checker "script/**/*.sh"

## Changelog

See [Releases page](https://github.com/pkgdeps/unverified-checksum-checker/releases).

## Running tests

Install devDependencies and Run `npm test`:

    npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/pkgdeps/unverified-checksum-checker/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- azu: [GitHub](https://github.com/azu), [Twitter](https://twitter.com/azu_re)

## License

MIT © azu
npm package: @pkgjs/create
Description: [![NPM Version](https://img.shields.io/npm/v/@pkgjs/create.svg)](https://npmjs.org/package/@pkgjs/create) [![NPM Downloads](https://img.shields.io/npm/dm/@pkgjs/create.svg)](https://npmjs.org/package/@pkgjs/create) [![Build Status](https://travis-ci.org/w
Author: Wes Todd
Latest version: 0.2.0

# @pkgjs/create

[![NPM Version](https://img.shields.io/npm/v/@pkgjs/create.svg)](https://npmjs.org/package/@pkgjs/create)
[![NPM Downloads](https://img.shields.io/npm/dm/@pkgjs/create.svg)](https://npmjs.org/package/@pkgjs/create)
[![Build Status](https://travis-ci.org/wesleytodd/@pkgjs/create.svg?branch=master)](https://travis-ci.org/wesleytodd/@pkgjs/create)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/standard/standard)



```
$ npm i @pkgjs/create
```
npm package: @pkgjs/statusboard
Description: A dashboard for project status
Author: Wes Todd
Latest version: 0.1.4

# A Project Status Board

A WIP attempt to centralize all the work being done in a community
of GitHub projects.  When you have work spread across multiple repos
and multiple orginizations, it is often hard to track things.  This
is what `@pkgjs/statusboard` aims to solve.

This repository is managed by the [Package Maintenance Working Group](https://github.com/nodejs/package-maintenance), see [Governance](https://github.com/nodejs/package-maintenance/blob/master/Governance.md).


## Example

Example statusboards using `@pkgjs/statusboard`:

- <https://expressjs.github.io/statusboard/> - [Github](https://github.com/expressjs/statusboard)


## Setup

WARNING: work in process, the following doesn't work yet, but soon!

The easiest way to create a status board for your project is using Github Pages.  To get started, create a new repo for your project and clone it
to your development machine.  In the new directory run the following:

```
# Creates a statusboard project
# @TODO make this command actually work as it does not right now
$ npx @pkgjs/statusboard create

# Setup your config in `index.js
# Then commit your work
$ git commit -am "statusboard setup"

# Create an orphan branch for our builds
$ git checkout --orphan gh-pages

# Remove the files we dont need here
$ git rm -rf .

# Create a .nojekyll file, this turns off pesky github pages stuff
$ touch .nojekyll
$ git commit --am "github pages initial commit"

# Now we setup the branch as a working tree on the master branch
$ git checkout master
$ mkdir build
$ git worktree add build gh-pages

# Now we can run the index and build
$ npm run build

# Now we should have a site in ./build, we can
# commit and push the branches now
$ cd build && git add . && git commit -m "our new statuspage" && git push
```

## TODO

- Cli logger
- `create` command to setup a new project
- Contribution graph like on github
- Meetings page (pull tag "meeting")
- Typescript support (load typings or if authored in TS)
- People/Teams (specify and display teams, for example the express TC)
- GH CI status
- Pinned projects
npm package: @pkgjs/support
Description: Package support information (see: https://github.com/nodejs/package-maintenance/pull/220)
Author: Wes Todd
Latest version: 0.0.6

# Package Support

[![NPM Version](https://img.shields.io/npm/v/@pkgjs/support.svg)](https://npmjs.org/package/@pkgjs/support)
[![NPM Downloads](https://img.shields.io/npm/dm/@pkgjs/support.svg)](https://npmjs.org/package/@pkgjs/support)
[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg)](https://github.com/standard/semistandard)
[![CI Test](https://github.com/pkgjs/support/workflows/Test/badge.svg)](https://github.com/pkgjs/support/actions)

![support backing](https://img.shields.io/badge/support%20backing-HOBBY-blue.svg)
![support target](https://img.shields.io/badge/support%20target-LTS-red.svg)
![support response-def](https://img.shields.io/badge/support%20response-best--effort-yellow.svg)

When an author releases an Open Source package there are many different levels
of support they may intend to provide.  The [Node.js Package Maintenance Working Group](https://github.com/nodejs/package-maintenance)
is working to propose [a spec](https://github.com/nodejs/package-maintenance/blob/HEAD/docs/PACKAGE-SUPPORT.md) to help package authors declare their intended support goals.  This package provides
some tooling around working with the format proposed.

This repository is managed by the [Package Maintenance Working Group](https://github.com/nodejs/package-maintenance), see [Governance](https://github.com/nodejs/package-maintenance/blob/HEAD/Governance.md).

## Command line usage

A command line tool is provided which supports the following commands:

* show - show the support info for the package tree.
* validate - validate support info for a package, to be used by a 
  maintainer before publishing.
* create - setup a support declaration for a package.

These commands support the following options:

* --canonical  - prefer canonical data over package support data
  that may be available locally. Default is `false`.
* --fetch - if local support data is not available or --canonical
  is specified, fetch the support data from the remote canonical
  location when needed. Default is `false`
* --base-path - directory root within which the tool can read/validate
  package support files. The default is the directory from which the
  package.json for the top level package was read.

More details and explanation of the use cases for these
commands is provided in [command line usage](./doc/command-line-usage.md).

The simplest way to run the tool is to simply run:

```
npx @pkgjs/support show
```

```
npx @pkgjs/support validate
```

```
npx @pkgjs/support create
```