{"id":17096068,"url":"https://github.com/souvikns/ink-router-cli","last_synced_at":"2025-04-12T23:24:22.549Z","repository":{"id":48932425,"uuid":"363636021","full_name":"Souvikns/ink-router-cli","owner":"Souvikns","description":"A react-router style CLI parser for InkJS. ","archived":false,"fork":false,"pushed_at":"2021-07-05T04:38:54.000Z","size":503,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T21:24:16.638Z","etag":null,"topics":["cli","nodejs","react","typescript"],"latest_commit_sha":null,"homepage":"https://ink-router-cli.onrender.com/","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/Souvikns.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}},"created_at":"2021-05-02T11:37:22.000Z","updated_at":"2024-09-29T23:54:18.000Z","dependencies_parsed_at":"2022-09-13T04:14:21.463Z","dependency_job_id":null,"html_url":"https://github.com/Souvikns/ink-router-cli","commit_stats":null,"previous_names":["souvikns/ink-cli-parser"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Souvikns%2Fink-router-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Souvikns%2Fink-router-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Souvikns%2Fink-router-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Souvikns%2Fink-router-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Souvikns","download_url":"https://codeload.github.com/Souvikns/ink-router-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248644632,"owners_count":21138599,"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","nodejs","react","typescript"],"created_at":"2024-10-14T14:44:33.644Z","updated_at":"2025-04-12T23:24:22.528Z","avatar_url":"https://github.com/Souvikns.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/Souvikns/ink-router-cli/blob/main/static/connection.svg\" width=\"200\" /\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003e  Ink-Router-Cli\n\u003cbr\u003e \u003cbr\u003e\n\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://github.com/Souvikns/ink-cli-parser/actions/workflows/node.js.yml\"\u003e\u003cimg alt=\"GitHub license\" src=\"https://github.com/Souvikns/ink-cli-parser/actions/workflows/node.js.yml/badge.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Souvikns/ink-router-cli/blob/main/LICENSE\"\u003e\u003cimg alt=\"GitHub license\" src=\"https://img.shields.io/github/license/Souvikns/ink-cli-parser\"\u003e\u003c/a\u003e\n\u003ca href=\"https://deepscan.io/dashboard#view=project\u0026tid=8580\u0026pid=17016\u0026bid=374285\"\u003e\u003cimg src=\"https://deepscan.io/api/teams/8580/projects/17016/branches/374285/badge/grade.svg\" alt=\"DeepScan grade\"\u003e\u003c/a\u003e\n\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dw/ink-router-cli\"\u003e\n\n\u003c/p\u003e\n\n\u003c/h1\u003e\n\n## ink-cli-parser\n\nink-cli-parser is a cli parser tool that is built just for\n[ink](https://github.com/vadimdemedes/ink). You can pass in you custom ink help\ncomponent and error component.\n\n## Table Of Contents\n\n- [Getting Started](#getting-started)\n  - [Installation](#installation)\n- [Usage](#usage)\n- [Api reference](#api-reference)\n\n## Getting Started\n\nTo install `ink-cli-parser`, ensure that you have Node.js \u003e=10.\n[Install nodejs from here](https://nodejs.org/en/)\n\n### Installation\n\nThe easiest way to install `ink-cli-parser` is using NPM. If you have Node.js\ninstalled, it is most likely that you have NPM installed as well\n\n```\n$ npm install ink-cli-parser\n```\n\n## Usage\n\n```tsx\nimport React, { FC } from \"react\";\nimport { Router, Switch, Command } from \"ink-cli-router\";\nimport { render, Text } from \"ink\";\n\nconst Create = () =\u003e {\n  return \u003cText\u003e{\"Creating file\"}\u003c/Text\u003e;\n};\n\nconst App: FC\u003c{ any }\u003e = () =\u003e {\n  return (\n    \u003cRouter argv={process.argv}\u003e\n      \u003cSwitch\u003e\n        \u003cCommand name=\"create\" component={\u003cCreate /\u003e} /\u003e\n      \u003c/Switch\u003e\n    \u003c/Router\u003e\n  );\n};\n\nrender(\u003cApp /\u003e);\n```\n\n![ss](https://github.com/Souvikns/ink-cli-parser/blob/main/ss.PNG)\n\n---\n\n## Api Reference\nTo read more about the API you can visit [here](https://ink-router-cli.onrender.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsouvikns%2Fink-router-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsouvikns%2Fink-router-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsouvikns%2Fink-router-cli/lists"}