{"id":15293049,"url":"https://github.com/codait/magicat","last_synced_at":"2025-04-13T12:28:54.243Z","repository":{"id":33377727,"uuid":"157469669","full_name":"CODAIT/magicat","owner":"CODAIT","description":"🧙😺 magicat - Deep learning magic.. with the convenience of cat!","archived":false,"fork":false,"pushed_at":"2022-10-11T23:29:58.000Z","size":13524,"stargazers_count":24,"open_issues_count":10,"forks_count":4,"subscribers_count":27,"default_branch":"master","last_synced_at":"2024-05-01T23:32:50.607Z","etag":null,"topics":["cli-utilities","computer-vision","deep-learning","image-recognition","image-segmentation"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CODAIT.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":"2018-11-14T01:11:58.000Z","updated_at":"2023-11-17T02:56:55.000Z","dependencies_parsed_at":"2022-08-24T13:30:18.741Z","dependency_job_id":null,"html_url":"https://github.com/CODAIT/magicat","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CODAIT%2Fmagicat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CODAIT%2Fmagicat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CODAIT%2Fmagicat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CODAIT%2Fmagicat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CODAIT","download_url":"https://codeload.github.com/CODAIT/magicat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248713742,"owners_count":21149761,"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-utilities","computer-vision","deep-learning","image-recognition","image-segmentation"],"created_at":"2024-09-30T16:38:45.906Z","updated_at":"2025-04-13T12:28:54.208Z","avatar_url":"https://github.com/CODAIT.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## 🧙😺 `magicat`\n### _Deep learning magic... with the convenience of `cat`!_\n\nA Deep Learning powered CLI utility that brings computer vision to your command line!\n\n![basic usage](assets/01-basic.gif)\n\nAt it's core, `magicat` is a tool that allows you to identify the objects contained in an image file. \n\nIt does this by leveraging the power of the [`@codait/max-image-segmenter`](https://github.com/CODAIT/max-tfjs-models/tree/master/image-segmenter#readme), which is a [TensorFlow.js](https://www.tensorflow.org/js) port of the [MAX Image Segmenter](https://developer.ibm.com/exchanges/models/all/max-image-segmenter/) pre-trained model. The MAX Image Segmenter is one of the many free-to-use, open-source deep learning models available on [IBM's Model Asset eXchange](https://developer.ibm.com/exchanges/models/all/).\n\nIn addition to displaying an image's contents, `magicat` has extended this functionality by offering several commands that allow you to search over directories with multiple images for certain objects, save individual objects as new image files, show in-terminal previews of objects, and more.\n\nKeep reading for quick-and-easy install instructions, some information on the basic commands that are available, and some GIFs to help you get started.\n\n### Prerequisites\n\n- Node.js v10.x or higher\n\n## Installation Instructions\n\nInstall using `npm` to automatically add the `magicat` command to your PATH.\n```\n$ npm install -g @codait/magicat\n```\n\nThat's it! \n\nNow you can begin using `magicat` like your very own command-line crystal ball 🔮 to identify what objects are contained in an image.\n\n## Basic Commands\n\n\u003e For more detailed usage information, see the in-app **help page** which can be accessed by executing `magicat -h`\n\nUse the basic command \n\n```\n$ magicat \u003cfile|directory|url\u003e\n```\nto **identify** what objects are contained in an image. If you have multiple images you'd like to inspect, you can provide the path to a directory containing image files. In addition, you may also provide a URL to an image.\n\nTo **scan a directory** of images for a certain object, use the `--contains` option.\n\n![contains usage](assets/02-contains.gif)\n\n\nIf you'd like to see an in-terminal **preview** of any of these objects, use the `--preview` flag, followed by the name of the object you'd like to see.\n\n![object preview](assets/03-preview.gif)\n\n\u003e _Object preview made possible thanks to @sindresorhus and [`terminal-image`](https://github.com/sindresorhus/terminal-image)_\n\n\nTo **save** any of the objects as individual image files, use the `--save` flag, followed by the name of the object you'd like to save, or leave the name blank to save all objects.\n\n![saving objects](assets/04-save.gif)\n\n\u003e By default, the individual image files are saved in the same directory as the source image (or current working directory for image URLs). To specify a different directory to save files use the `--output` flag.\n\nTo **remove** an object or background from an image, use the `--remove` flag, followed by the name of the object you'd like to remove or the shorthand aliases `bg` to remove the background. A copy of the image is saved with the specified object removed.\n\n![removing objects](assets/05-remove.gif)\n\n\u003e By default, the individual image files are saved in the same directory as the source image (or current working directory for image URLs). To specify a different directory to save files use the `--output` flag.\n\n## Licenses\n\n| Component | License | Link  |\n| ------------- | --------  | -------- |\n| This repository | [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) | [LICENSE](LICENSE) |\n| Model Code (3rd party) | [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) | [TensorFlow Models Repository](https://github.com/tensorflow/models/blob/master/LICENSE) |\n| Model Weights | [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) | [TensorFlow Models Repository](https://github.com/tensorflow/models/blob/master/LICENSE) |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodait%2Fmagicat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodait%2Fmagicat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodait%2Fmagicat/lists"}