Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Legoless/Alpha
Next generation debugging framework for iOS
https://github.com/Legoless/Alpha
Last synced: 8 days ago
JSON representation
Next generation debugging framework for iOS
- Host: GitHub
- URL: https://github.com/Legoless/Alpha
- Owner: Legoless
- License: mit
- Created: 2014-10-31T11:18:10.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-08-10T19:17:26.000Z (over 7 years ago)
- Last Synced: 2024-11-20T02:00:08.167Z (22 days ago)
- Language: Objective-C
- Homepage: https://github.com/Legoless/Alpha
- Size: 30.6 MB
- Stars: 732
- Watchers: 34
- Forks: 45
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Alpha - Next generation debugging framework for iOS. (Debugging / Getting Started)
- awesome-ios-star - Alpha - Next generation debugging framework for iOS. (Debugging / Getting Started)
- project-awesome - Legoless/Alpha - Next generation debugging framework for iOS (Objective-C)
- fucking-awesome-ios - Alpha - Next generation debugging framework for iOS. (Debugging / Getting Started)
- fucking-awesome-ios - Alpha - Next generation debugging framework for iOS. (Debugging / Getting Started)
README
[](http://waffle.io/legoless/alpha)
[](http://github.com/legoless/Dominus)
[](https://travis-ci.org/legoless/Alpha)
[](https://github.com/Carthage/Carthage)
[](http://github.com/legoless/Alpha)
[](http://cocoadocs.org/docsets/Alpha/)
[](http://cocoadocs.org/docsets/Alpha/)
[](http://opensource.org/licenses/MIT)
**Alpha** is the idea of a next generation debugging framework for iOS applications. It combines multiple debugging tools built on top of a **simple, unified API**. It lives entirely in your application sandbox and collects information during your application lifetime. The integration can be done in less than a minute and requires **no code changes**.
Watch [presentation](https://www.youtube.com/watch?v=XlycM-37DQw) by [Dal Rupnik](https://github.com/legoless) of **Alpha** idea at [**SwiftConf 2015**](http://objcgn.com).
***The project is a work in progress and might be too unstable to be used in real environment yet. Feel free to open GitHub issues (especially Swift projects). Currently the most unstable is the Heap plugin, so it might be best to avoid using it (might be removed in the future, as it is technically impossible to know when memory is freed by the OS in an asynchronous way).***
# Features
Features are separated into plugins, which can be enabled or disabled, depending on application requirements.
- **Application** - displays a list of all installed applications on the device.
- **Bootstrap** - checks for [KZBootstrap](https://github.com/krzysztofzablocki/KZBootstrap) environments and allows modifying them in real-time (deprecated).
- **Console** - displays console logs (logged by NSLog) inside the application.
- **Event** - logs and displays application wide events such as background state transitions and view controller appearances.
- **File** - allows browsing the sandboxed file system and previewing common file types, such as images, videos and text.
- **Global** - information plugin displays linked frameworks, libraries and classes.
- **Heap** - allows inspection of active object instances on ther heap and helps with debugging memory errors.
- **Interface** - plugin is a specific plugin and is required to display Alpha menu interface and actions.
- **Keychain** - browse items in keychain added by the application.
- **Network** - logs network connections made using `NSURLSession` and `NSURLConnection` API's.
- **Notification** - displays scheduled and fired local notifications, received push notifications and notification permissions.
- **Object** - allows for inspection of any class or object in the application, including `NSUserDefaults`, arrays and dictionaries.
- [**Permission**](https://github.com/Legoless/Alpha/wiki/Permission-Plugin) - displays current permissions and adds the ability to request specific permission.
- [**Remote**](https://github.com/Legoless/Alpha/wiki/Remote-Plugin) - plugin allows connecting to Alpha from another device (needs Bonjour running on target).
- **Screenshot** - plugin allows taking screenshots of the application with a single action.
- **Server** - contains a simple Bonjour server allowing Alpha to work over local Wi-Fi network.
- **State** - allows inspecting the device state and settings, such as locale, time and available memory.
- [**Touch**](https://github.com/Legoless/Alpha/wiki/Touch-Plugin) - plugin displays touches on screen when activated and their force touch.
- **View** - allows view hierarchy manipulation and inspection in real-time.
Currently work in progress:
**0.4.0**
- *Application State Snapshot*
- *Display crashes inside Alpha*
- *Font Family list*
- *Remote client target*
- *Larger example apps with more functionality*
- *In-app debugger*
- *Resetting permissions (if possible to implement over TCC framework)*
### Themes
Alpha is meant to work with any application, but the default dark theme does not always fit best with the application color scheme.
To fit in with any application Alpha has theme support, which allows you to choose the color palette you wish to display Alpha in.
There are **6 themes** available:
- [Default](https://raw.githubusercontent.com/Legoless/Alpha/master/Resources/Default_Theme.png) (first picture)
- [Formentera](https://raw.githubusercontent.com/Legoless/Alpha/master/Resources/Formentera_Theme.png) (second picture)
- [Notio](https://raw.githubusercontent.com/Legoless/Alpha/master/Resources/Notio_Theme.png) (third picture)
- [Alizarin](https://raw.githubusercontent.com/Legoless/Alpha/master/Resources/Alizarin_Theme.png) - *by [Vikilas](http://vikilas.com)*
- [Amethyst](https://raw.githubusercontent.com/Legoless/Alpha/master/Resources/Amethyst_Theme.png) - *by [Vikilas](http://vikilas.com)*
- [Green Sea](https://raw.githubusercontent.com/Legoless/Alpha/master/Resources/GreenSea_Theme.png) - *by [Vikilas](http://vikilas.com)*
If is also possible to create your own theme and use it in Alpha system.
*Read more on [Themes](https://github.com/Legoless/Alpha/wiki/Themes).*
### Triggers
Triggers are a way to activate Alpha interface from your application. By default Alpha provides two triggers:
- **Shake Trigger** - Activates when device is shaken two times in less than 5 seconds.
- **Tap Trigger** - Activates when 3 fingers are pressed for 3 seconds anywhere in the application.
Both triggers are activated by default. Alternatively you can implement your own trigger or use the manual trigger.
*Read more on [Triggers](https://github.com/Legoless/Alpha/wiki/Triggers).*
# Integration
Alpha is separated into 2 frameworks:
- Service
- Plugins
- Interface
Service module is installed into your app and executed when the application launches. It automatically initializes plugins and starts collecting data from your application.
Service framework includes Bonjour server, which can be activated by any of the available triggers.
Alpha.framework includes both Service framework and interface module.
To use Alpha in your project, all you need to do is add a **CocoaPods** library:
```ruby
pod 'Alpha'
```
This automatically includes all plugins and features. To avoid clashes with any libraries used in application, all Alpha classes use `ALPHA` prefix (even classes ported from other libraries). The recommended way is to ignore Alpha version and always use the latest version, to ensure best stability possible.
You can also pick only the plugins you need manually.
```ruby
pod 'Alpha/Bonjour'
pod 'Alpha/Interface'
pod 'Alpha/State'
```
To use automatic integration feature, add Integration subspec (when using Alpha pod, it is automatically included).
```ruby
pod 'Alpha/Integration'
```
*Alpha supports iOS 8 and up. Not all features are available on all versions. tvOS and watchOS versions coming soon.*
*Read more on [Integration](https://github.com/Legoless/Alpha/wiki/Integration).*
# The Story
*Alpha originally started as an unofficial fork from [FLEX](https://github.com/Flipboard/FLEX) (Flipboard Explorer). It began with a simple desire to add multiple features to FLEX, but looking at it more and more, it was obvious that many architectural changes were required to support remote clients. Those kind of changes are the hardest to merge into original repository without breaking multiple features, it was obvious that it fits more to create a separate repository.*
*So Alpha was converted into a separate repository and work began on top of that. Many features were added and there are many architectural changes under the hood. Alpha is now not a separate tool, but a framework that offers a full API. Features from tools are now working on top of plugin API, which allows dynamic loading and incredible extensibility.*
# Documentation
The entire Alpha documentation is available on [Wiki](https://github.com/Legoless/Alpha/wiki) and on [CocoaDocs](http://cocoadocs.org/docsets/Alpha).
- Read [Getting Started](https://github.com/Legoless/Alpha/wiki/Getting-Started).
- Browse [Architecture](https://github.com/Legoless/Alpha/wiki/Architecture).
- Go through [Frequently Asked Questions](https://github.com/Legoless/Alpha/wiki/Frequently-Asked-Questions).
# Contributions
To contribute to Alpha, please open pull requests. Any feature implementations or improvements, bug fixes, documentation are very welcome.
# Thanks
This project would not be possible without all the work done by many respected community contributors.
Thanks to all contributors of the following projects:
- [**FLEX (Flipboard Explorer)**](https://github.com/Flipboard/FLEX)
- [CKCircleMenuView](https://github.com/JaNd3r/CKCircleMenuView)
- [CWStatusBarNotification](https://github.com/cezarywojcik/CWStatusBarNotification)
- [DTBonjour](https://github.com/Cocoanetics/DTBonjour)
- [Haystack](https://github.com/legoless/Haystack)
- [iConsole](https://github.com/nicklockwood/iConsole)
- [KZBootstrap](https://github.com/krzysztofzablocki/KZBootstrap)
- [PonyDebugger](https://github.com/square/PonyDebugger)
- [PINCache](https://github.com/pinterest/PINCache)
- [Super DB](https://github.com/Shopify/superdb)
- [Touchpose](https://github.com/toddreed/Touchpose)
- [ISHPermissionKit](https://github.com/iosphere/ISHPermissionKit)
- Many more...
Contact
======
Dal Rupnik
- [legoless](https://github.com/legoless) on **GitHub**
- [@thelegoless](https://twitter.com/thelegoless) on **Twitter**
- [[email protected]](mailto:[email protected])
License
======
**Alpha** is released under the **MIT** license. See [LICENSE](https://github.com/Legoless/Alpha/blob/master/LICENSE) file for more information.