bitburner-src/markdown/bitburner.ns.flags.md

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [flags](./bitburner.ns.flags.md)

## NS.flags() method

Parse command line flags.

<b>Signature:</b>

```typescript
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg };
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  schema | \[string, string \| number \| boolean \| string\[\]\]\[\] |  |

<b>Returns:</b>

{ \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) }

## Remarks

RAM cost: 0 GB

Allows unix like flag parsing.

## Example


```ts
// example.script
var data = flags([
    ['delay', 0], // a default number means this flag is a number
    ['server', 'foodnstuff'], //  a default string means this flag is a string
    ['exclude', []], // a default array means this flag is a default array of string
    ['help', false], // a default boolean means this flag is a boolean
]);
tprint(data);

// example.js
export async function main(ns) {
  const data = ns.flags([
    ['delay', 0], // a default number means this flag is a number
    ['server', 'foodnstuff'], //  a default string means this flag is a string
    ['exclude', []], // a default array means this flag is a default array of string
    ['help', false], // a default boolean means this flag is a boolean
  ]);
  ns.tprint(data);
}

// [home ~/]> run example.script
// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false}
// [home ~/]> run example.script --delay 3000
// {"_":[],"server":"foodnstuff","exclude":[],"help":false,"delay":3000}
// [home ~/]> run example.script --delay 3000 --server harakiri-sushi
// {"_":[],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"}
// [home ~/]> run example.script --delay 3000 --server harakiri-sushi hello world
// {"_":["hello","world"],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"}
// [home ~/]> run example.script --delay 3000 --server harakiri-sushi hello world --exclude a --exclude b
// {"_":["hello","world"],"help":false,"delay":3000,"server":"harakiri-sushi","exclude":["a","b"]}
// [home ~/]> run example.script --help
// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true}
```