# chili_debug_view

**Repository Path**: wsj2012/chili_debug_view

## Basic Information

- **Project Name**: chili_debug_view
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-26
- **Last Updated**: 2025-12-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Chili Debug view

This package allows to see network logs from mobile device. 
This can help QA engineers to better debug your app features

# Get started

Package uses dio (https://pub.dev/packages/dio) starting from version 5.5.0 to provide network logs,
so in order to use this package your requests must go through dio.

For sharing it uses share_plus (https://pub.dev/packages/share_plus)
and path_provider (https://pub.dev/packages/path_provider) 

## Install 

Add `chili_debug_view` to your `pubspec.yaml`:

```
dependencies:
  chili_debug_view: ^1.1.0
```

## Usage

1. Wrap your app via DebugView providing navigation key

```
import 'package:chili_debug_view/chili_debug_view.dart';

...
class _AppState extends State<App> {
  final rootKey = GlobalKey<NavigatorState>();

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: rootKey,
      builder: (_, app) {
        return DebugView(
          navigatorKey: rootKey,
          showDebugViewButton: true,
          app: app,
        );
      },
      ...
    );
  }
...
```

2. To see network logs you need to add interceptor to your dio

```
import 'package:chili_debug_view/chili_debug_view.dart';

dio.interceptors.add(NetworkLoggerInterceptor());
```

# Sample Project

There is an [example app](https://github.com/ChiliLabs/chili_debug_view/tree/main/example) with simple request and app wrapping.

![example.gif](doc/assets/example.gif)