Skip to main content
Module

x/cliffy/flags/flags.ts>parseFlags

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
c4spar/deno-cliffy
Extremely Popular
Latest
function parseFlags
import { parseFlags } from "https://deno.land/x/cliffy@v1.0.0-rc.4/flags/flags.ts";

Parse command line arguments.

Type Parameters

TFlags extends Record<string, unknown>
TFlagOptions extends FlagOptions
TFlagsResult extends ParseFlagsContext

Parameters

argsOrCtx: string[] | TFlagsResult

Command line arguments e.g: Deno.args or parse context.

optional
opts: ParseFlagsOptions<TFlagOptions> = [UNSUPPORTED]

Parse options.

import { parseFlags } from "./flags.ts";

parseFlags(Deno.args);

$ examples/flags/flags.ts -x 3 -y.z -n5 -abc --beep=boop foo bar baz --deno.land --deno.com -- --cliffy
{
flags: {
x: "3",
y: { z: true },
n: "5",
a: true,
b: true,
c: true,
beep: "boop",
deno: { land: true, com: true }
},
literal: [ "--cliffy" ],
unknown: [ "foo", "bar", "baz" ],
stopEarly: false,
stopOnUnknown: false
}