{"id":15085961,"url":"https://github.com/powerpuffpenguin/ts-flags","last_synced_at":"2026-02-14T05:06:33.525Z","repository":{"id":63980064,"uuid":"571641252","full_name":"powerpuffpenguin/ts-flags","owner":"powerpuffpenguin","description":"Command line argument parser for deno and node.js","archived":false,"fork":false,"pushed_at":"2023-05-22T08:35:17.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-05T05:42:40.230Z","etag":null,"topics":["cli","command","command-flags","command-line","deno","deno-cli","deno-command","deno-flags","flags","nodejs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/powerpuffpenguin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-28T15:12:40.000Z","updated_at":"2022-11-28T18:30:34.000Z","dependencies_parsed_at":"2024-09-11T18:17:48.007Z","dependency_job_id":"74968610-2e91-46bc-bfa4-8624bfc5d333","html_url":"https://github.com/powerpuffpenguin/ts-flags","commit_stats":{"total_commits":8,"total_committers":2,"mean_commits":4.0,"dds":0.125,"last_synced_commit":"778e64a17efc221986c0320f2fe783feb2000f7a"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/powerpuffpenguin%2Fts-flags","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/powerpuffpenguin%2Fts-flags/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/powerpuffpenguin%2Fts-flags/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/powerpuffpenguin%2Fts-flags/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/powerpuffpenguin","download_url":"https://codeload.github.com/powerpuffpenguin/ts-flags/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243806029,"owners_count":20350773,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command","command-flags","command-line","deno","deno-cli","deno-command","deno-flags","flags","nodejs"],"created_at":"2024-09-25T07:02:18.041Z","updated_at":"2026-02-14T05:06:28.501Z","avatar_url":"https://github.com/powerpuffpenguin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# flags\n\nCommand line argument parser for deno and node.js\n\n**Features:**\n\n- Simple to use but rich in features\n- Supports using '-' to define short flags and '--' to define long flags\n- Automatically verify flags\n- Support subcommands\n- All commands have built-in support -h/--help flags output usage instructions\n\n**Index:**\n\n- [Background](#Background)\n- [Install](#Install)\n- Usage\n  - [Command](#Command)\n  - [Verify Flags](#Verify-Flags)\n  - [Subcommands](#Subcommands)\n- [Document](https://powerpuffpenguin.github.io/ts/flags/)\n\n# Background\n\nI found that deno is very suitable for writing command line programs, but there\nis no easy-to-use and feature-rich command line parsing library, so I wrote one\nmyself, because it is a pure syntax parsing that does not use deno features, so\nnode.js or other js The operating environment can also be used normally\n\n# Install\n\nIf you use deno you can create a deps.ts:\n\n```\nexport * from \"https://deno.land/x/flags@0.0.3/mod.ts\";\n```\n\nIf you have nodejs you can use npm or similar package management tool to\ninstall:\n\n```\nnpm install @king011/flags\n```\n\n# Command\n\nCommand represents a command and passes it to Parser for parameter parsing\n\n```\nimport { Command, Parser } from \"./deps.ts\";\nconst root = new Command({\n  use: \"main.ts\",\n  short: \"Demonstrates how to use the flags library\",\n  // Set up a preprocessor for defining flags\n  prepare(flags) {\n    // define a string flag\n    const s = flags.string({\n      name: \"string\",\n      short: \"s\",\n      default: \"-\",\n      usage: \"define a string flag\",\n    });\n    // define a bool flag\n    const v = flags.bool({\n      name: \"version\",\n      usage: \"print app version\",\n    });\n    // define array flag\n    const n = flags.numbers({\n      name: \"number\",\n      short: \"n\",\n      usage: \"define a Array\u003cnumber\u003e flag\",\n    });\n\n    // Returns a callback function to handle the code to be executed by the command\n    return (args) =\u003e {\n      // Use closures to get parsed flags values\n      if (v.value) {\n        console.log(\"version: v0.0.1\");\n      }\n      console.log(\"string=\", s.value);\n      console.log(\"numbers=\", n.value);\n      // other args\n      console.log(\"args=\", args);\n    };\n  },\n});\n\nnew Parser(root).parse(Deno.args);\n```\n\nFor **nodejs** users only need to modify import and the parameters passed to\nparse\n\n```\nimport { Command, Parser } from \"@king011/flags\";\n\nnew Parser(root).parse(process.argv.splice(2));\n```\n\n\u003e Subsequent examples only need to modify import and parse to execute in the\n\u003e nodejs environment, so I won’t repeat them here\n\n# Verify Flags\n\nWhen defining flags, its data type needs to be clearly specified, and class\nFlags will verify whether the parameter can be converted to a valid type when\nparsing\n\nIn addition, you can explicitly specify a values array to define valid values,\nor define a validation function to validate parameters\n\n```\nimport { Command, Parser } from \"./deps.ts\";\nconst root = new Command({\n  use: \"verify.ts\",\n  short: \"Demonstrates how to verify flags\",\n  prepare(flags) {\n    const port = flags.number({\n      name: \"port\",\n      short: \"p\",\n      usage: \"listen port\",\n      default: 80,\n      isValid: (v) =\u003e {\n        return Math.floor(v) == v \u0026\u0026 v \u003e 0 \u0026\u0026 v \u003c 65535;\n      },\n    });\n    const scheme = flags.string({\n      name: \"scheme\",\n      short: \"s\",\n      default: \"http\",\n      usage: \"protocol scheme\",\n      values: [\n        \"http\",\n        \"https\",\n        \"rpc\",\n        \"grpc\",\n      ],\n    });\n    return () =\u003e {\n      console.log(`${scheme.value} listen on port ${port.value}`);\n    };\n  },\n});\n\nnew Parser(root).parse(Deno.args);\n```\n\n# Subcommands\n\nCommand has an add function that can add other Commands as its own subcommands\n\n```\nimport { Command, Parser } from \"./deps.ts\";\nconst root = new Command({\n  use: \"main.ts\",\n  short: \"Demonstrates how to add sub commands\",\n  run(_, cmd) {\n    cmd.print();\n  },\n});\n\nroot.add(\n  new Command({\n    use: \"add\",\n    short: \"sum of numbers\",\n    run(args) {\n      let num = 0;\n      for (let i = 0; i \u003c args.length; i++) {\n        const n = parseInt(args[i]);\n        if (!isFinite(n)) {\n          throw new Error(`args[${i}] is not a int: ${n}`);\n        }\n        num += n;\n      }\n      console.log(`num=${num}`);\n    },\n  }),\n  new Command({\n    use: \"join\",\n    short: \"join strings\",\n    prepare(flags) {\n      const separator = flags.string({\n        name: \"separator\",\n        short: \"s\",\n        default: \",\",\n        usage:\n          \"A string used to separate one element of the array from the next in the resulting string.\",\n      });\n      return (args) =\u003e {\n        console.log(args.join(separator.value));\n      };\n    },\n  }),\n);\nnew Parser(root).parse(Deno.args);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpowerpuffpenguin%2Fts-flags","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpowerpuffpenguin%2Fts-flags","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpowerpuffpenguin%2Fts-flags/lists"}