{"id":15486008,"url":"https://github.com/fakoua/ink","last_synced_at":"2025-04-22T16:43:11.404Z","repository":{"id":62421649,"uuid":"231268014","full_name":"fakoua/ink","owner":"fakoua","description":"Terminal string color for Deno","archived":false,"fork":false,"pushed_at":"2022-07-29T14:11:31.000Z","size":194,"stargazers_count":10,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-17T07:16:58.339Z","etag":null,"topics":["ansi-colors","cli","console","css","deno","html","style","terminal","typescript"],"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/fakoua.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":"2020-01-01T21:53:55.000Z","updated_at":"2023-12-26T05:24:05.000Z","dependencies_parsed_at":"2022-11-01T17:31:22.970Z","dependency_job_id":null,"html_url":"https://github.com/fakoua/ink","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fakoua%2Fink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fakoua%2Fink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fakoua%2Fink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fakoua%2Fink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fakoua","download_url":"https://codeload.github.com/fakoua/ink/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249986722,"owners_count":21356473,"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":["ansi-colors","cli","console","css","deno","html","style","terminal","typescript"],"created_at":"2024-10-02T06:05:39.077Z","updated_at":"2025-04-22T16:43:11.381Z","avatar_url":"https://github.com/fakoua.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ink\r\n\r\nTerminal string color for deno\r\n\r\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/fakoua/ink?style=for-the-badge)\r\n![GitHub](https://img.shields.io/github/license/fakoua/ink?style=for-the-badge)\r\n![GitHub last commit](https://img.shields.io/github/last-commit/fakoua/ink?style=for-the-badge)\r\n![GitHub Workflow Status](https://img.shields.io/github/workflow/status/fakoua/ink/Deno%20CI?style=for-the-badge)\r\n\r\n## Run the welcome page for interactive demo:\r\n\r\n```bash\r\ndeno run -A https://deno.land/x/ink/welcome.ts\r\n```\r\n\r\n## Examples\r\n\r\n```ts\r\nimport * as ink from 'https://deno.land/x/ink/mod.ts'\r\n\r\nlet text = ink.colorize('\u003cred\u003eHello World\u003c/red\u003e')\r\nconsole.log(text)\r\n```\r\n\r\nOutput:\r\n\r\n```diff\r\n- Hello World\r\n```\r\n\r\nYou can use nested style:\r\n\r\n```ts\r\nimport * as ink from 'https://deno.land/x/ink/mod.ts'\r\n\r\nlet text = ink.colorize('\u003cbg-blue\u003e\u003cred\u003eHello World\u003c/bg-blue\u003e\u003c/red\u003e')\r\n\r\nconsole.log(text)\r\n```\r\n\r\n## Support tags [Simple Mode]\r\n\r\n- \u0026lt;b\u003e: bold\r\n- \u0026lt;i\u003e: italic\r\n- \u0026lt;u\u003e: underline\r\n- \u0026lt;s\u003e: strikethrough\r\n- \u0026lt;hidden\u003e: hidden text\r\n- \u0026lt;inv\u003e: inverted color\r\n- \u0026lt;dim\u003e: dim light\r\n- \u0026lt;u\u003e: underline\r\n\r\n- \u0026lt;red\u003e: text red\r\n- \u0026lt;green\u003e: text green\r\n- \u0026lt;blue\u003e: text blue\r\n- \u0026lt;yellow\u003e: text yellow\r\n- \u0026lt;magenta\u003e: text magenta\r\n- \u0026lt;cyan\u003e: text cyan\r\n- \u0026lt;white\u003e: text white\r\n- \u0026lt;black\u003e: text black\r\n\r\n- \u0026lt;bg-red\u003e: background red\r\n- \u0026lt;bg-green\u003e: background green\r\n- \u0026lt;bg-blue\u003e: background blue\r\n- \u0026lt;bg-yellow\u003e: background yellow\r\n- \u0026lt;bg-magenta\u003e: background magenta\r\n- \u0026lt;bg-cyan\u003e: background cyan\r\n- \u0026lt;bg-white\u003e: background white\r\n- \u0026lt;bg-black\u003e: background black\r\n\r\n## Alias to console\r\n\r\nYou can use the object terminal to call console.log, console.trace ... directly form ink module.\r\n\r\n```ts\r\nimport * as ink from 'https://deno.land/x/ink/mod.ts'\r\n\r\nink.terminal.log('\u003cred\u003eHello\u003c/red\u003e %s', '\u003cb\u003eWorld\u003c/b\u003e')\r\n```\r\n\r\n## Advanced mode\r\n\r\nYou can use html like style for advanced and nested mode using the `ink` tag:\r\n\r\n```ts\r\nimport * as ink from 'https://deno.land/x/ink/mod.ts'\r\n\r\nlet result = ink.html(\"\u003cink style='color: #ff0000;font:bold;'\u003eHello World\u003c/ink\u003e\")\r\nconsole.log(result);\r\n```\r\n\r\n**ink** also supports nested styles:\r\n\r\n```ts\r\nlet html = `\r\n\u003cink style=\"color: rgb(255, 0, 0); background-color: #00ff00;font: underline, bold\"\u003e\r\n    I'm Red, background Green, underlined and bold! \r\n    \u003cink style=\"background-color: rgb(0, 0, 0); font: italic;\"\u003e\r\n        My BG is black again, but I'm italic :(\r\n    \u003c/ink\u003e\r\n    My BG is Green Again!\r\n\u003c/ink\u003e\r\nNo Format here\r\n`\r\n\r\nlet result = ink.html(html)\r\nconsole.log(result);\r\n```\r\n\r\nOutput:\r\n\r\n![output](forgit/img01.png)\r\n\r\n## String Extension\r\n\r\n`ink` also supports string extension:\r\n\r\n```ts\r\nimport \"https://deno.land/x/ink/mod.ts\" //Import .toColor() extension\r\n\r\nconsole.log(\"\u003cink style='color: #ff0000; font: bold'\u003eHello Deno\u003c/ink\u003e\".toColor())\r\n```\r\n\r\n### Supported Styles\r\n\r\n- **color**: Hex Or RGB [#ff0000, rgb(0, 255, 0) ...]\r\n- **background-color**: Hex Or RGB [#ff0000, rgb(0, 255, 0) ...]\r\n- **font**: comma separated values [bold, dim, italic, underline, inverse, hidden, strikethrough]\r\n\r\n## Draw Image\r\n\r\nInk module also can draw a JPEG image from local or remote source into the terminal:\r\n\r\n```ts\r\nimport * as ink from \"./mod.ts\"\r\n\r\nawait ink.drawImage(\"https://placekitten.com/50/50\")\r\n\r\n```\r\n\r\n![output](forgit/img02.png)\r\n\r\n## License\r\n\r\n[MIT](LICENSE)\r\n\r\n\r\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ffakoua%2Fink.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ffakoua%2Fink?ref=badge_large)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffakoua%2Fink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffakoua%2Fink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffakoua%2Fink/lists"}