1111## Install
1212
1313``` shell
14- npm install bargs
14+ npm install @boneskull/ bargs
1515```
1616
1717## Why bargs?
@@ -74,7 +74,7 @@ Only Node.js v22+.
7474## Quick Start
7575
7676``` typescript
77- import { bargs } from ' bargs' ;
77+ import { bargs } from ' @boneskull/ bargs' ;
7878
7979const result = bargs ({
8080 name: ' greet' ,
@@ -111,7 +111,7 @@ const result = bargs({
111111Instead, use ** ` bargsAsync() ` ** :
112112
113113``` typescript
114- import { bargsAsync } from ' bargs' ;
114+ import { bargsAsync } from ' @boneskull/ bargs' ;
115115
116116// Async - handlers can return Promises
117117const result = await bargsAsync ({
@@ -353,7 +353,7 @@ bargs(config, { theme: 'mono' });
353353The ` ansi ` export provides common ANSI escape codes for styled terminal output: text styles (` bold ` , ` dim ` , ` italic ` , ` underline ` , etc.), foreground colors, background colors, and their ` bright* ` variants. Use this to create your own themes (instead of hardcoding ANSI escape codes).
354354
355355``` typescript
356- import { ansi } from ' bargs' ;
356+ import { ansi } from ' @boneskull/ bargs' ;
357357
358358bargs (someConfig , {
359359 theme: {
@@ -402,7 +402,12 @@ Available theme color slots:
402402** bargs** exports some ` Error ` subclasses:
403403
404404``` typescript
405- import { bargs , BargsError , HelpError , ValidationError } from ' bargs' ;
405+ import {
406+ bargs ,
407+ BargsError ,
408+ HelpError ,
409+ ValidationError ,
410+ } from ' @boneskull/bargs' ;
406411
407412try {
408413 bargs (config );
@@ -425,7 +430,7 @@ try {
425430Generate help text without calling ` bargs() ` :
426431
427432``` typescript
428- import { generateHelp , generateCommandHelp } from ' bargs' ;
433+ import { generateHelp , generateCommandHelp } from ' @boneskull/ bargs' ;
429434
430435const helpText = generateHelp (config );
431436const commandHelp = generateCommandHelp (config , ' migrate' );
@@ -436,7 +441,7 @@ const commandHelp = generateCommandHelp(config, 'migrate');
436441Create clickable terminal hyperlinks ([ OSC 8] ( https://github.com/Alhadis/OSC8-Adoption ) ):
437442
438443``` typescript
439- import { link , linkifyUrls , supportsHyperlinks } from ' bargs' ;
444+ import { link , linkifyUrls , supportsHyperlinks } from ' @boneskull/ bargs' ;
440445
441446// Check if terminal supports hyperlinks
442447if (supportsHyperlinks ()) {
@@ -460,7 +465,7 @@ import {
460465 defaultTheme , // The default theme object
461466 stripAnsi , // Remove ANSI codes from string
462467 themes , // All built-in themes
463- } from ' bargs' ;
468+ } from ' @boneskull/ bargs' ;
464469
465470// Create a custom styler
466471const styler = createStyler ({ colors: { flag: ansi .green } });
0 commit comments