{"id":16413467,"url":"https://github.com/noblemajo/cmdy","last_synced_at":"2025-03-23T06:31:18.646Z","repository":{"id":57201184,"uuid":"437411302","full_name":"NobleMajo/cmdy","owner":"NobleMajo","description":"A js cmd argument framework that looks like the docker cli tool.","archived":true,"fork":false,"pushed_at":"2025-02-10T17:04:03.000Z","size":485,"stargazers_count":18,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T00:42:58.674Z","etag":null,"topics":["cli","cmd","cmdline","javascript","javascript-library","linux-bash","linux-shell","node","nodejs","npm","npm-library","npm-package","typescript","typescript-library"],"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/NobleMajo.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":"2021-12-11T23:32:14.000Z","updated_at":"2025-02-10T17:04:13.000Z","dependencies_parsed_at":"2024-10-11T06:51:37.853Z","dependency_job_id":null,"html_url":"https://github.com/NobleMajo/cmdy","commit_stats":null,"previous_names":["majo418/cmdy"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NobleMajo%2Fcmdy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NobleMajo%2Fcmdy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NobleMajo%2Fcmdy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NobleMajo%2Fcmdy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NobleMajo","download_url":"https://codeload.github.com/NobleMajo/cmdy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245066496,"owners_count":20555402,"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","cmd","cmdline","javascript","javascript-library","linux-bash","linux-shell","node","nodejs","npm","npm-library","npm-package","typescript","typescript-library"],"created_at":"2024-10-11T06:51:35.184Z","updated_at":"2025-03-23T06:31:18.636Z","avatar_url":"https://github.com/NobleMajo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cmdy (deprecated)\n\n![CI/CD](https://github.com/majo418/cmdy/workflows/Publish/badge.svg)\n![MIT](https://img.shields.io/badge/license-MIT-blue.svg)\n![typescript](https://img.shields.io/badge/dynamic/json?style=plastic\u0026color=blue\u0026label=Typescript\u0026prefix=v\u0026query=devDependencies.typescript\u0026url=https%3A%2F%2Fraw.githubusercontent.com%2Fmajo418%2Fcmdy%2Fmain%2Fpackage.json)\n![npm](https://img.shields.io/npm/v/cmdy.svg?style=plastic\u0026logo=npm\u0026color=red)\n![github](https://img.shields.io/badge/dynamic/json?style=plastic\u0026color=darkviolet\u0026label=GitHub\u0026prefix=v\u0026query=version\u0026url=https%3A%2F%2Fraw.githubusercontent.com%2Fmajo418%2Fcmdy%2Fmain%2Fpackage.json)\n\n![](https://img.shields.io/badge/dynamic/json?color=green\u0026label=watchers\u0026query=watchers\u0026suffix=x\u0026url=https%3A%2F%2Fapi.github.com%2Frepos%2Fmajo418%2Fcmdy)\n![](https://img.shields.io/badge/dynamic/json?color=yellow\u0026label=stars\u0026query=stargazers_count\u0026suffix=x\u0026url=https%3A%2F%2Fapi.github.com%2Frepos%2Fmajo418%2Fcmdy)\n![](https://img.shields.io/badge/dynamic/json?color=orange\u0026label=subscribers\u0026query=subscribers_count\u0026suffix=x\u0026url=https%3A%2F%2Fapi.github.com%2Frepos%2Fmajo418%2Fcmdy)\n![](https://img.shields.io/badge/dynamic/json?color=navy\u0026label=forks\u0026query=forks\u0026suffix=x\u0026url=https%3A%2F%2Fapi.github.com%2Frepos%2Fmajo418%2Fcmdy)\n![](https://img.shields.io/badge/dynamic/json?color=darkred\u0026label=open%20issues\u0026query=open_issues\u0026suffix=x\u0026url=https%3A%2F%2Fapi.github.com%2Frepos%2Fmajo418%2Fcmdy)\n\n# table of contents \n- [cmdy](#cmdy)\n- [table of contents](#table-of-contents)\n- [about](#about)\n- [Features](#features)\n  - [General](#general)\n  - [cmd (sub cmd)](#cmd-sub-cmd)\n  - [flags](#flags)\n- [Getting started](#getting-started)\n  - [1. Install package](#1-install-package)\n  - [2. Add example code](#2-add-example-code)\n- [npm scripts](#npm-scripts)\n  - [use](#use)\n  - [base scripts](#base-scripts)\n  - [watch mode](#watch-mode)\n- [contribution](#contribution)\n\n# about\n\"cmdy\" is a node js cmd argument framework that looks like the docker cli tool.\n\n# Features\n\n## General\n - root and sub commands\n - differend cmd callbacks\n - state and value flags\n\n## cmd (sub cmd)\n - own flags\n - global gflas\n - premade or custom help function/generator\n - cmd groups\n\n## flags\n - value flags with types\n - default values\n - aliases\n - shorthand\n\n# Getting started\n## 1. Install package\n```sh\nnpm i cmdy\n```\n\n## 2. Add example code\n```ts\nimport { Flag, parseCmd, CmdDefinition } from \"../src/index\"\n\nconst force: Flag = {\n    name: \"force\",\n    description: \"The force flag\",\n}\n\nconst port: Flag = {\n    name: \"port\",\n    description: \"The port flag\",\n    shorthand: \"p\",\n    types: [\"number\"]\n}\n\nconst verbose: Flag = {\n    name: \"verbose\",\n    description: \"The verbose flag\",\n    shorthand: \"V\",\n}\n\nconst version: Flag = {\n    name: \"version\",\n    description: \"The verbose flag\",\n    alias: [\"v\", \"ve\", \"ver\", \"vers\", \"versi\", \"versio\"],\n    shorthand: \"v\",\n}\n\nconst ps: CmdDefinition = {\n    name: \"ps\",\n    description: \"The ps command\",\n    flags: [\n        port\n    ],\n    allowUnknownArgs: true,\n    exe: async (res) =\u003e console.log(\"ps: \", res.cmd.name + \"\\nres-data:\\n\", res.flags, res.valueFlags)\n}\n\nconst start: CmdDefinition = {\n    name: \"start\",\n    description: \"The start command\",\n    flags: [\n        port\n    ],\n    exe: async (res) =\u003e console.log(\"start: \", res.cmd.name + \"\\nres-data:\\n\", res.flags, res.valueFlags)\n}\n\nconst stop: CmdDefinition = {\n    name: \"stop\",\n    description: \"The stop command\",\n    flags: [\n        force\n    ],\n    exe: async (res) =\u003e console.log(\"stop: \", res.cmd.name + \"\\nres-data:\\n\", res.flags, res.valueFlags)\n}\n\nconst root: CmdDefinition = {\n    name: \"testcmd\",\n    description: \"The root testcmd command\",\n    cmds: [\n        start,\n        stop,\n        ps,\n    ],\n     flags: [\n        version\n    ],\n    //exe: async () =\u003e console.log(\"asdasdd\")\n}\n\nparseCmd({\n    cmd: root,\n    globalFlags: [\n        verbose\n    ]\n}).exe()\n```\n\n# npm scripts\nThe npm scripts are made for linux but can also work on mac and windows.\n## use\nYou can run npm scripts in the project folder like this:\n```sh\nnpm run \u003cscriptname\u003e\n```\nHere is an example:\n```sh\nnpm run test\n```\n\n## base scripts\nYou can find all npm scripts in the `package.json` file.\nThis is a list of the most important npm scripts:\n - test // test the app\n - build // build the app\n - exec // run the app\n - start // build and run the app\n\n## watch mode\nLike this example you can run all npm scripts in watch mode:\n```sh\nnpm run start:watch\n```\n\n# contribution\n - 1. fork the project\n - 2. implement your idea\n - 3. create a pull/merge request\n```ts\n// please create seperated forks for different kind of featues/ideas/structure changes/implementations\n```\n\n---\n**cya ;3**  \n*by majo418*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoblemajo%2Fcmdy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoblemajo%2Fcmdy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoblemajo%2Fcmdy/lists"}