Display pretty Android and iOS logs without Android Studio or Console.app, with intuitive Command Line Interface.
npm install logkitty[![Version][version]][package]
[![PRs Welcome][prs-welcome-badge]][prs-welcome]
[![MIT License][license-badge]][license]
[![Chat][chat-badge]][chat]
[![Code of Conduct][coc-badge]][coc]
Display __pretty__ Android and iOS logs __without Android Studio or Console.app__, with __intuitive__ Command Line Interface.
!Demo
``sh`
yarn global add logkitty
Or if you prefer having it locally:
`sh`
yarn add -D logkitty
yarn logkitty --help
`sh`
logkitty
You can inspect available platforms, command and options for a given platform by adding -h at the end, for example:
`sh`
logkitty -h # prints available platforms and global options
logkitty android -h # prints commands and options for android
logkitty android tag -h # prints tag command syntax and options for android
* platform: android:tag
* - Show logs with matching tags.app
* - Show logs from application with given identifier.match
* - Show logs matching given patterns (all regexes have flags g and m).custom
* - Use custom patters supported by Logcat.all
* - Show all logs.ios
* platform: :tag
* - Show logs with matching tags (where tag is usually a name of the app).match
* - Show logs matching given patterns (all regexes have flags g and m).all
* - Show all logs.
* common:
* -h, --help - Display help-v, --version
* - Display versionandroid
* platform :
tag, app, match and all commands support additional priority filtering options (sorted by priority):
* -U, -u - Unknown priority (lowest)-v, -v
* - Verbose priority-D, -d
* - Debug priority (default)-I, -i
* - Info priority-W, -w
* - Warn priority-E, -e
* - Error priority-F, -f
* - Fatal priority-S, -s
* - Silent priority (highest)
For example logkitty android all -W will display all logs with priority __warn__, __error__ and __fatal__.
* platform ios:
tag, match and all commands support additional level filtering options:
* -D, -d - Debug level-I, -i
* - Info level-E, -e
* - Error level
Show all logs with tag ReactNativeJS (and default priority - __debug and above__):
`sh`
logkitty android tag ReactNativeJS
logkitty ios tag ReactNativeJS
Show all logs with priority __info and above__ from application with identifier com.example.myApplication:
`sh`
logkitty android app com.example.myApplication -i
Show all logs matching /CodePush/gm regex:
`sh`
logkitty android match CodePush
logkitty ios match CodePush
Show all logs with priority __error__ or __fatal__ for Android and __error_ level for iOS:
`sh`
logkitty android all -e
logkitty ios all -e
Show logs using custom patterns - silence all logs and display only the onces with tag my-tag and priority __debug and above__:
`sh``
logkitty android custom *:S my-tag:D
If your building a tool and want to use Node API, head over to Node API documentation.
[license-badge]: https://img.shields.io/npm/l/logkitty.svg?style=flat-square
[license]: https://opensource.org/licenses/MIT
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs-welcome]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/zamotany/logkitty/blob/master/CODE_OF_CONDUCT.md
[chat-badge]: https://img.shields.io/badge/chat-discord-brightgreen.svg?style=flat-square&colorB=7289DA&logo=discord
[chat]: https://discord.gg/zwR2Cdh
[version]: https://img.shields.io/npm/v/logkitty.svg?style=flat-square
[package]: https://www.npmjs.com/package/logkitty