{"id":16485805,"url":"https://github.com/zamotany/logkitty","last_synced_at":"2025-04-05T07:08:07.287Z","repository":{"id":44149180,"uuid":"167453066","full_name":"zamotany/logkitty","owner":"zamotany","description":"Display pretty Android and iOS logs without Android Studio or Console.app, with intuitive Command Line Interface.","archived":false,"fork":false,"pushed_at":"2024-02-28T15:37:14.000Z","size":1692,"stargazers_count":70,"open_issues_count":17,"forks_count":13,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-12T13:27:08.108Z","etag":null,"topics":["android","cli","logcat","pretty"],"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/zamotany.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2019-01-24T23:22:06.000Z","updated_at":"2024-07-24T07:29:46.000Z","dependencies_parsed_at":"2024-06-18T13:34:29.950Z","dependency_job_id":"a7a5a836-a339-4cd9-98e0-095b305241ba","html_url":"https://github.com/zamotany/logkitty","commit_stats":{"total_commits":46,"total_committers":9,"mean_commits":5.111111111111111,"dds":"0.30434782608695654","last_synced_commit":"6f6c78564345464a06e4a28b0bb420a714c6b1c3"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zamotany%2Flogkitty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zamotany%2Flogkitty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zamotany%2Flogkitty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zamotany%2Flogkitty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zamotany","download_url":"https://codeload.github.com/zamotany/logkitty/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299833,"owners_count":20916190,"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":["android","cli","logcat","pretty"],"created_at":"2024-10-11T13:27:20.005Z","updated_at":"2025-04-05T07:08:07.270Z","avatar_url":"https://github.com/zamotany.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# logkitty\n\n[![Version][version]][package]\n\n[![PRs Welcome][prs-welcome-badge]][prs-welcome]\n[![MIT License][license-badge]][license]\n[![Chat][chat-badge]][chat]\n[![Code of Conduct][coc-badge]][coc]\n\nDisplay __pretty__ Android and iOS logs __without Android Studio or Console.app__,  with __intuitive__ Command Line Interface.\n\n![Demo](./logkitty.gif)\n\n## Installation\n\n```sh\nyarn global add logkitty\n```\n\nOr if you prefer having it locally:\n\n```sh\nyarn add -D logkitty\nyarn logkitty --help\n```\n\n## Usage\n\n```sh\nlogkitty \u003cplatform\u003e \u003ccommand\u003e [options]\n```\n\n### Command line help\n\nYou can inspect available platforms, command and options for a given platform by adding `-h` at the end, for example:\n\n```sh\nlogkitty -h # prints available platforms and global options\nlogkitty android -h # prints commands and options for android\nlogkitty android tag -h # prints tag command syntax and options for android\n```\n\n### Commands\n\n* platform: `android`:\n  * `tag \u003ctags...\u003e` - Show logs with matching tags.\n  * `app \u003cappId\u003e` - Show logs from application with given identifier.\n  * `match \u003cregexes...\u003e` - Show logs matching given patterns (all regexes have flags `g` and `m`).\n  * `custom \u003cpatterns...\u003e` - Use custom [patters supported by Logcat](https://developer.android.com/studio/command-line/logcat#filteringOutput).\n  * `all` - Show all logs.\n* platform: `ios`:\n  * `tag \u003ctags...\u003e` - Show logs with matching tags (where tag is usually a name of the app).\n  * `match \u003cregexes...\u003e` - Show logs matching given patterns (all regexes have flags `g` and `m`).\n  * `all` - Show all logs.\n\n### Options\n\n* common:\n  * `-h, --help` - Display help\n  * `-v, --version` - Display version\n* platform `android`:\n\n  `tag`, `app`, `match` and `all` commands support additional priority filtering options (sorted by priority):\n\n  * `-U, -u` - Unknown priority (lowest)\n  * `-v, -v` - Verbose priority\n  * `-D, -d` - Debug priority (default)\n  * `-I, -i` - Info priority\n  * `-W, -w` - Warn priority\n  * `-E, -e` - Error priority\n  * `-F, -f` - Fatal priority\n  * `-S, -s` - Silent priority (highest)\n\n  For example `logkitty android all -W` will display all logs with priority __warn__, __error__ and __fatal__.\n\n* platform `ios`:\n\n  `tag`, `match` and `all` commands support additional level filtering options:\n\n  * `-D, -d` - Debug level\n  * `-I, -i` - Info level\n  * `-E, -e` - Error level\n\n### Examples\n\nShow all logs with tag `ReactNativeJS` (and default priority - __debug and above__):\n\n```sh\nlogkitty android tag ReactNativeJS\nlogkitty ios tag ReactNativeJS\n```\n\nShow all logs with priority __info and above__ from application with identifier `com.example.myApplication`:\n\n```sh\nlogkitty android app com.example.myApplication -i\n```\n\nShow all logs matching `/CodePush/gm` regex:\n\n```sh\nlogkitty android match CodePush\nlogkitty ios match CodePush\n```\n\nShow all logs with priority __error__ or __fatal__ for Android and __error_ level for iOS:\n\n```sh\nlogkitty android all -e\nlogkitty ios all -e\n```\n\nShow logs using custom patterns - silence all logs and display only the onces with tag `my-tag` and priority __debug and above__:\n\n```sh\nlogkitty android custom *:S my-tag:D\n```\n\n### Node API\n\nIf your building a tool and want to use Node API, head over to [Node API documentation](./docs/NODE_API.md).\n\n\u003c!-- badges (common) --\u003e\n\n[license-badge]: https://img.shields.io/npm/l/logkitty.svg?style=flat-square\n[license]: https://opensource.org/licenses/MIT\n[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs-welcome]: http://makeapullrequest.com\n[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square\n[coc]: https://github.com/zamotany/logkitty/blob/master/CODE_OF_CONDUCT.md\n[chat-badge]: https://img.shields.io/badge/chat-discord-brightgreen.svg?style=flat-square\u0026colorB=7289DA\u0026logo=discord\n[chat]: https://discord.gg/zwR2Cdh\n\n[version]: https://img.shields.io/npm/v/logkitty.svg?style=flat-square\n[package]: https://www.npmjs.com/package/logkitty\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzamotany%2Flogkitty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzamotany%2Flogkitty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzamotany%2Flogkitty/lists"}