{"id":1076,"url":"https://github.com/tadija/AEConsole","last_synced_at":"2025-08-06T13:32:58.855Z","repository":{"id":56900284,"uuid":"55018786","full_name":"tadija/AEConsole","owner":"tadija","description":"Customizable Console UI overlay with debug log on top of your iOS App","archived":false,"fork":false,"pushed_at":"2022-03-30T11:13:13.000Z","size":259,"stargazers_count":148,"open_issues_count":1,"forks_count":21,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-30T21:42:57.000Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Swift","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/tadija.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-30T00:02:05.000Z","updated_at":"2024-05-03T09:15:21.000Z","dependencies_parsed_at":"2022-08-21T02:20:56.782Z","dependency_job_id":null,"html_url":"https://github.com/tadija/AEConsole","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tadija%2FAEConsole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tadija%2FAEConsole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tadija%2FAEConsole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tadija%2FAEConsole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tadija","download_url":"https://codeload.github.com/tadija/AEConsole/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228905520,"owners_count":17989779,"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":[],"created_at":"2024-01-05T20:15:38.402Z","updated_at":"2024-12-09T14:31:09.664Z","avatar_url":"https://github.com/tadija.png","language":"Swift","funding_links":[],"categories":["Debugging","Libs","Logging","Logging [🔝](#readme)"],"sub_categories":["Getting Started","Logging","Other free courses","Linter"],"readme":"[![Swift 5.5](https://img.shields.io/badge/Swift-5.5-orange.svg?style=flat)](https://swift.org)\n[![Platforms iOS](https://img.shields.io/badge/Platforms-iOS-lightgray.svg?style=flat)](http://www.apple.com)\n[![CocoaPods](https://img.shields.io/cocoapods/v/AEConsole.svg?style=flat)](https://cocoapods.org/pods/AEConsole)\n[![Carthage](https://img.shields.io/badge/Carthage-compatible-brightgreen.svg?style=flat)](https://github.com/Carthage/Carthage)\n[![Swift Package Manager](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)\n[![License MIT](https://img.shields.io/badge/License-MIT-lightgrey.svg?style=flat)](https://github.com/tadija/AELog/blob/master/LICENSE)\n\n# AEConsole\n\n**Customizable Console UI overlay with debug log on top of your iOS App**\n\n**AEConsole** is built on top of [AELog](https://github.com/tadija/AELog), so you should probably see that first.\n\u003e I wanted to see what's happening 'under the hood' while testing some app AFK (ex. outside).\n\u003e Then I made it possible. Hope you'll like it too, happy coding!\n\n![AEConsole](http://tadija.net/projects/AEConsole/AEConsole.png)\n\n## Index\n- [Features](#features)\n- [Usage](#usage)\n- [Quick Help](#quick-help)\n- [Installation](#installation)\n- [License](#license)\n\n## Features\n- **All the things** from [AELog](https://github.com/tadija/AELog) plus:\n- Console UI overlay **on top of your App**\n- **Debug log on device** in real time\n- **Automatic row height** for all log lines\n- **Forward touches** to your App\n- **Shake to toggle** Console UI\n- **Filter log** to find exactly what you need\n- **Export log** to file if you need it for later\n- **Share log file** easily via system sharing sheet\n- **Customize look** as you like it\n\n## Usage\n\nCalling `Console.shared.configure(in: window)` will add `Console.View` as a subview to your App's window and make it hidden by default.\nWhenever 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.\n\nThe rest is up to [AELog's](https://github.com/tadija/AELog) logging functionality. Whatever is logged with it, will show up in `Console.View`.\n\n```swift\n// MARK: - Console configuration\n\nfunc application(_ application: UIApplication,\n                 didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -\u003e Bool\n{\n    /// - Note: Access Console settings\n    let settings = Console.shared.settings\n\n    /// - Note: Customize Console settings like this, these are defaults:\n    settings.isShakeGestureEnabled = true\n    settings.backColor = UIColor.black\n    settings.textColor = UIColor.white\n    settings.fontSize = 12.0\n    settings.rowSpacing = 4.0\n    settings.opacity = 0.7\n\n    /// - Note: Configure Console in app window (it's recommended to skip this for public release)\n    Console.shared.configure(in: window)\n\n    /// - Note: Log something with AELog\n    aelog()\n\n    return true\n}\n```\n\n```swift\n// MARK: - Additional Console API\n\n/// - Note: Check if Console is hidden\nConsole.shared.isHidden\n\n/// - Note: Toggle Console visibility\nConsole.shared.toggle()\n\n/// - Note: Add any log line manually\nConsole.shared.addLogLine(line: \"Hello!\")\n\n/// - Note: Export log file manually\nConsole.shared.exportLogFile { (fileURL) in\n    do {\n        let url = try fileURL()\n        /// - Note: do something with a log file at given file URL...\n    } catch {\n        print(error)\n    }\n}\n```\n\n## Quick Help\n\nThis should explain all the features of Console UI:\n\n![AEConsole](http://tadija.net/projects/AEConsole/AEConsole-QuickHelp.png)\n\nFeature | Description\n------------ | -------------\nExport Log | will make `AELog_{timestamp}.txt` file in Application Documents directory and present sharing sheet.\nFilter Log | filter is not case sensitive.\nToggle Toolbar | works for both filter and menu toolbars simultaneously.\nToggle Forward Touches | when active you can interact with your App, otherwise you can interact with the log.\nToggle Auto Follow | when active it will automatically scroll to the new log lines, otherwise it will stay put.\nClear Log | you can't undo this.\nPan Gesture over Menu Toolbar | left is more transparent, right is more opaque.\n\n## Installation\n\n- [Swift Package Manager](https://swift.org/package-manager/):\n    \n    ```swift\n    .package(url: \"https://github.com/tadija/AEConsole.git\", from: \"0.7.2\")\n    ```\n  \n- [Carthage](https://github.com/Carthage/Carthage):\n\n\t```ogdl\n\tgithub \"tadija/AEConsole\"\n\t```\n\t\n- [CocoaPods](http://cocoapods.org/):\n\n\t```ruby\n\tpod 'AEConsole'\n\t```\n\n## License\nAEConsole is released under the MIT license. See [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftadija%2FAEConsole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftadija%2FAEConsole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftadija%2FAEConsole/lists"}