\n\n \n\n# cli-utils (@-xun/cli)\n\n\n\nOpinionated utilities for building CLIs on top of Black Flag.\n\n\n\n---\n\n\n\n\n\n\n- [Install](#install)\n- [Usage](#usage)\n- [Appendix](#appendix)\n - [Published Package Details](#published-package-details)\n - [License](#license)\n- [Contributing and Support](#contributing-and-support)\n - [Contributors](#contributors)\n\n\n\n\n\n \n\n## Install\n\n\n\nTo install:\n\n```shell\nnpm install @-xun/cli\n```\n\n> [!TIP]\n>\n> `@-xun/cli` already comes bundled with (and re-exports) [@black-flag/core][1],\n> [@black-flag/extensions][2], and [@black-flag/checks][3]. _`@-xun/cli` is an\n> all-in-one package!_ Redundantly installing the `@black-flag/*` packages may\n> lead to version mis-matches, which can cause strange bugs.\n\n## Usage\n\n\n\nTODO\n\n\n\n## Appendix\n\n\n\nFurther documentation can be found under [`docs/`][x-repo-docs].\n\n\n\n\n### Published Package Details\n\nThis is a [CJS2 package][x-pkg-cjs-mojito] with statically-analyzable exports\nbuilt by Babel for use in Node.js versions that are not end-of-life. For\nTypeScript users, this package supports both `\"Node10\"` and `\"Node16\"` module\nresolution strategies.\n\n\n\n\n\nExpand details\n\nThat means both CJS2 (via `require(...)`) and ESM (via `import { ... } from ...`\nor `await import(...)`) source will load this package from the same entry points\nwhen using Node. This has several benefits, the foremost being: less code\nshipped/smaller package size, avoiding [dual package\nhazard][x-pkg-dual-package-hazard] entirely, distributables are not\npacked/bundled/uglified, a drastically less complex build process, and CJS\nconsumers aren't shafted.\n\nEach entry point (i.e. `ENTRY`) in [`package.json`'s\n`exports[ENTRY]`][x-repo-package-json] object includes one or more [export\nconditions][x-pkg-exports-conditions]. These entries may or may not include: an\n[`exports[ENTRY].types`][x-pkg-exports-types-key] condition pointing to a type\ndeclaration file for TypeScript and IDEs, a\n[`exports[ENTRY].module`][x-pkg-exports-module-key] condition pointing to\n(usually ESM) source for Webpack/Rollup, a `exports[ENTRY].node` and/or\n`exports[ENTRY].default` condition pointing to (usually CJS2) source for Node.js\n`require`/`import` and for browsers and other environments, and [other\nconditions][x-pkg-exports-conditions] not enumerated here. Check the\n[package.json][x-repo-package-json] file to see which export conditions are\nsupported.\n\nNote that, regardless of the [`{ \"type\": \"...\" }`][x-pkg-type] specified in\n[`package.json`][x-repo-package-json], any JavaScript files written in ESM\nsyntax (including distributables) will always have the `.mjs` extension. Note\nalso that [`package.json`][x-repo-package-json] may include the\n[`sideEffects`][x-pkg-side-effects-key] key, which is almost always `false` for\noptimal [tree shaking][x-pkg-tree-shaking] where appropriate.\n\n\n\n\n\n\n\n### License\n\n\n\nSee [LICENSE][x-repo-license].\n\n\n\n\n## Contributing and Support\n\n**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare]\nare always welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟\nthis project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Or [buy\nme a beer][x-repo-sponsor], I'd appreciate it. Thank you!\n\nSee [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for\nmore information.\n\n\n\n\n\n### Contributors\n\n\n\n\n\n\n[](#contributors-)\n\n\n\n\nThanks goes to these wonderful people ([emoji\nkey][x-repo-all-contributors-emojis]):\n\n\n\n\n\n\n
![](\"https://raw.githubusercontent.com/Xunnamius/cli-utils/refs/heads/main/logo.png\"){kind=logo}
\n![\"Bernard\"/](\"https://avatars.githubusercontent.com/u/656017?v=4?s=100\")
![](\"https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg\"){kind=logo}
\n Add your contributions\n \n