Customizable Console UI overlay with debug log on top of your iOS App

Marko Tadić

Last update: Dec 21, 2022

Related tags

Debugging AEConsole

Overview

AEConsole

Customizable Console UI overlay with debug log on top of your iOS App

AEConsole is built on top of AELog, so you should probably see that first.

I wanted to see what's happening 'under the hood' while testing some app AFK (ex. outside). Then I made it possible. Hope you'll like it too, happy coding!

Features

All the things from AELog plus:
Console UI overlay on top of your App
Debug log on device in real time
Automatic row height for all log lines
Forward touches to your App
Shake to toggle Console UI
Filter log to find exactly what you need
Export log to file if you need it for later
Share log file easily via system sharing sheet
Customize look as you like it

Usage

Calling Console.shared.configure(in: window) will add Console.View as a subview to your App's window and make it hidden by default. Whenever you need Console UI, you just make a shake gesture and it's there! When you no longer need it, shake again and it's gone.

The rest is up to AELog's logging functionality. Whatever is logged with it, will show up in Console.View.

// MARK: - Console configuration

func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool
{
    /// - Note: Access Console settings
    let settings = Console.shared.settings

    /// - Note: Customize Console settings like this, these are defaults:
    settings.isShakeGestureEnabled = true
    settings.backColor = UIColor.black
    settings.textColor = UIColor.white
    settings.fontSize = 12.0
    settings.rowSpacing = 4.0
    settings.opacity = 0.7

    /// - Note: Configure Console in app window (it's recommended to skip this for public release)
    Console.shared.configure(in: window)

    /// - Note: Log something with AELog
    aelog()

    return true
}

// MARK: - Additional Console API

/// - Note: Check if Console is hidden
Console.shared.isHidden

/// - Note: Toggle Console visibility
Console.shared.toggle()

/// - Note: Add any log line manually
Console.shared.addLogLine(line: "Hello!")

/// - Note: Export log file manually
Console.shared.exportLogFile { (fileURL) in
    do {
        let url = try fileURL()
        /// - Note: do something with a log file at given file URL...
    } catch {
        print(error)
    }
}

Quick Help

This should explain all the features of Console UI:

Feature	Description
Export Log	will make `AELog_{timestamp}.txt` file in Application Documents directory and present sharing sheet.
Filter Log	filter is not case sensitive.
Toggle Toolbar	works for both filter and menu toolbars simultaneously.
Toggle Forward Touches	when active you can interact with your App, otherwise you can interact with the log.
Toggle Auto Follow	when active it will automatically scroll to the new log lines, otherwise it will stay put.
Clear Log	you can't undo this.
Pan Gesture over Menu Toolbar	left is more transparent, right is more opaque.

Installation

Swift Package Manager:

.package(url: "https://github.com/tadija/AEConsole.git", from: "0.7.1")

Carthage:
```
 github "tadija/AEConsole"
```
CocoaPods:
```
 pod 'AEConsole'
```

License

AEConsole is released under the MIT license. See LICENSE for details.

You might also like...

Free macOS app for iOS view debugging.

Introduction You can inspect and modify views in iOS app via Lookin, just like UI Inspector in Xcode, or another app called Reveal. Official Website：h

575 Dec 28, 2022

In-app design review tool to inspect measurements, attributes, and animations.

Hyperion Hyperion - In App Design Review Tool What is it? Hyperion is a hidden plugin drawer that can easily be integrated into any app. The drawer si

2k Dec 27, 2022

App for developers to test REST API.

Httper Httper is a REST API test tool running on your iOS devices. It helps developers to test their REST APIs anywhere and anytime without PC. Featur

408 Nov 22, 2022

A lightweight, one line setup, iOS / OSX network debugging library! 🦊

Netfox provides a quick look on all executed network requests performed by your iOS or OSX app. It grabs all requests - of course yours, requests from

3.4k Dec 28, 2022

Set of easy to use debugging tools for iOS developers & QA engineers.

DBDebugToolkit DBDebugToolkit is a debugging library written in Objective-C. It is meant to provide as many easily accessible tools as possible while

1.2k Dec 30, 2022

Chisel is a collection of LLDB commands to assist debugging iOS apps.

Chisel Chisel is a collection of LLDB commands to assist in the debugging of iOS apps. [Installation • Commands • Custom Commands • Development Workfl

8.9k Jan 6, 2023

Next generation debugging framework for iOS

Alpha is the idea of a next generation debugging framework for iOS applications. It combines multiple debugging tools built on top of a simple, unifie

733 Oct 29, 2022

iOS network debugging, like a wizard 🧙‍♂️

Start debugging iOS network calls like a wizard, without extra code! Wormholy makes debugging quick and reliable. What you can do: No code to write an

2.1k Jan 8, 2023

Profiling / Debugging assist tools for iOS. (Memory Leak, OOM, ANR, Hard Stalling, Network, OpenGL, Time Profile ...)

MTHawkeye Readme 中文版本 MTHawkeye is profiling, debugging tools for iOS used in Meitu. It's designed to help iOS developers improve development producti

1.4k Dec 29, 2022

Comments

Dismisses keyboard when logging

Whenever I log something, this line is called and it removes focus from any UITextFields and thus dismisses the keyboard:

https://github.com/tadija/AEConsole/blob/1f9a7ac78a185d8f53e2e4867b82322a880d417a/Sources/AEConsole.swift#L91

opened by wgrand 2
Ho to manually export log to file

Hi,

there is a button, in AECOnsole, to export logs values, to a file, in document app folder.

how can I do that by code (swift, if possible) ?

I don't know how to contact you, so I posted a issue,

sorry for that

thanks Olivier

opened by olivier38070 1
Loading logs

Thank you very much for sharing this awesome project. I’d like to request a feature; loading existing log file. In a smart way that shows last x lines of log by default but supports scrolling up to see more ( load more)
enhancement help wanted

opened by wamra 0