<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [flags](./bitburner.ns.flags.md) ## NS.flags() method Parse command line flags. **Signature:** ```typescript flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] }; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | | **Returns:** { \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) \| string\[\] } ## Remarks RAM cost: 0 GB Allows Unix-like flag parsing. ## 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.js // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false} // [home ~/]> run example.js --delay 3000 // {"_":[],"server":"foodnstuff","exclude":[],"help":false,"delay":3000} // [home ~/]> run example.js --delay 3000 --server harakiri-sushi // {"_":[],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"} // [home ~/]> run example.js --delay 3000 --server harakiri-sushi hello world // {"_":["hello","world"],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"} // [home ~/]> run example.js --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} ```