Files
smart-city-digital-twin-mar…/smart-app-city/frontend/node_modules/logkitty/README.md
Eric FELIXINE e30ae8ed09 feat(smart-app): implement complete mobile app MVP
- App.tsx: full navigation (Auth stack + Main tabs with 5 screens)
- Auth: LoginScreen, RegisterScreen, ForgotPasswordScreen
- HomeScreen: dashboard with IoT metrics, weather widget, alerts, quick actions, sensors
- MapScreen: interactive map with layer toggles (6 layers)
- MarketplaceScreen: categories (6), products (5), search
- ChatScreen: AI chat with quick prompts (4), bot responses
- ProfileScreen: user info, stats, menu (9 items), logout
- AlertsScreen: alert list with severity, acknowledge
- SensorsScreen: sensor list with type filters (6 types), search
- ZonesScreen: zone cards with stats
- SettingsScreen: language picker (FR/EN/ES/DE), privacy, about
- Stores: iotStore (sensors, zones, alerts), notificationStore, uiStore + i18n
- Hooks: useSensors, useAlerts, useNotifications, useLocation
- Components: Card, Button, LoadingSpinner, ErrorBoundary, Header
- Services: iotService, notificationService (with axios API client)
- Utils: formatters (temp, AQI, noise, dates), validators (email, password, IBAN)
- Theme: colors.ts with full design system (Blue Ocean palette)
- Ditto: fixed MongoDB connection, new JWT secrets, official gateway image
2026-06-01 18:00:35 -04:00

136 lines
3.9 KiB
Markdown

# 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](./logkitty.gif)
## Installation
```sh
yarn global add logkitty
```
Or if you prefer having it locally:
```sh
yarn add -D logkitty
yarn logkitty --help
```
## Usage
```sh
logkitty <platform> <command> [options]
```
### Command line help
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
```
### Commands
* platform: `android`:
* `tag <tags...>` - Show logs with matching tags.
* `app <appId>` - Show logs from application with given identifier.
* `match <regexes...>` - Show logs matching given patterns (all regexes have flags `g` and `m`).
* `custom <patterns...>` - Use custom [patters supported by Logcat](https://developer.android.com/studio/command-line/logcat#filteringOutput).
* `all` - Show all logs.
* platform: `ios`:
* `tag <tags...>` - Show logs with matching tags (where tag is usually a name of the app).
* `match <regexes...>` - Show logs matching given patterns (all regexes have flags `g` and `m`).
* `all` - Show all logs.
### Options
* common:
* `-h, --help` - Display help
* `-v, --version` - Display version
* platform `android`:
`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
### Examples
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
```
### Node API
If your building a tool and want to use Node API, head over to [Node API documentation](./docs/NODE_API.md).
<!-- badges (common) -->
[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