Merge branch 'okwasniewski:main' into main

Author: schrobingus

README.md

@@ -6,7 +6,7 @@
 
 MiniSim is a small utility menu bar app for launching Android 🤖 and iOS  emulators (and more!).
 
-Written in Swift and AppKit. 
+Written in Swift and AppKit.
 
 ## Install
 
@@ -20,39 +20,40 @@ brew install --cask minisim
 
 You can use Minisim together with a [Raycast](https://www.raycast.com) extension.
 
-<a title="Install minisim Raycast Extension" href="https://www.raycast.com/okwasniewski/minisim"><img src="https://www.raycast.com/okwasniewski/minisim/[email protected]?v=1.1" height="64" alt="" style="height: 64px;"></a> 
+<a title="Install minisim Raycast Extension" href="https://www.raycast.com/okwasniewski/minisim"><img src="https://www.raycast.com/okwasniewski/minisim/[email protected]?v=1.1" height="64" alt="" style="height: 64px;"></a>
 
 ## Features
+
 - Lightweight
 - Fast, 100% native
 - Open Source
 - Open with shortcut: <kbd>⌥ + ⇧ + e</kbd>
 - Launch iOS emulators
-    - Copy device UDID
-    - Copy device name
-    - Delete simulators
+  - Copy device UDID
+  - Copy device name
+  - Delete simulators
 - Launch Android emulators
-    - Cold boot android emulators 
-    - Run android emulators without audio (Your bluetooth headphones will thank you 🎧)
-    - Toggle a11y on selected emulator
-    - Copy device name
-    - Copy device ADB id
+  - Cold boot android emulators
+  - Run android emulators without audio (Your bluetooth headphones will thank you 🎧)
+  - Toggle a11y on selected emulator
+  - Copy device name
+  - Copy device ADB id
 - Focus devices using accessibility API
-- Set default launch flags 
+- Set default launch flags
 - Indicate running devices
 
-
-## Screenshots 
+## Screenshots
 
 <img width="512" src="https://user-images.githubusercontent.com/52801365/223483262-aa3bad72-2948-4893-87a0-578e5d3d8e89.png">
 
 https://user-images.githubusercontent.com/52801365/224473566-a6248f20-8fc9-4b8e-ab95-64e85bc6d5c6.mp4
 
-## Usage 
+## Usage
 
 > **important**
-This utility uses `xcrun` and `sdk/emulator` to fetch available devices on your machine. 
-It might not work if you don't have a proper XCode and Android Studio setup.
+> This utility uses `xcrun` and `sdk/emulator` to fetch available devices on your machine.
+> It might not work if you don't have a proper XCode and Android Studio setup.
 
 There is a global shortcut for invoking the menu: <kbd>⌥ + ⇧ + e</kbd>.
 
+Checkout the docs [here](https://github.com/okwasniewski/MiniSim/tree/main/docs).

docs/custom_commands.md

@@ -0,0 +1,78 @@
+## What are custom commands?
+
+Custom commands allows you to add additional menu items that speed up your workflow. If you have a command that you execute regularly through terminal you can convert it to custom command and make your life easier.
+
+Some examples of custom commands:
+
+- Execute a sequence of clicks to log into your app
+- Reverse Android emulator port (for React Native)
+- Open iOS deep link
+- Open Logcat
+
+## Creating your first command
+
+1. Go to Preferences > Commands > Add new
+2. Assign a name
+3. Write custom command
+
+For Android you will most likely use ADB:
+
+```sh
+$adb_path -s $adb_id reverse tcp:8081 tcp:8081
+```
+
+You can find available variables that you can use based on selected toggles if command needs booted device or not.
+
+Let's break down the command:
+
+- `$adb_path` - absolute path of the ADB utility
+- `-s $adb_id` - executes command on emulator with a given ID (useful when you have multiple emulators running)
+- `reverse tcp:8081 tcp:8081` rest of the ADB command. Run `adb --help` to check out what can be done.
+
+For iOS you will most likely use `xcrun simctl` utility:
+
+```sh
+$xcrun_path simctl openurl booted "app://test.com"
+```
+
+You can identify simulators by the `$uuid` variable.
+
+4. Choose icon
+5. Click Add
+
+Done! ✅
+
+## Ready to use recipes
+
+Here you can find a list of ready to use commands.
+
+### Reverse React Native Metro port
+
+```sh
+$adb_path -s $adb_id reverse tcp:8081 tcp:8081
+```
+
+### Launch Logcat
+
+```sh
+osascript -e 'tell app "Terminal"
+    do script "adb logcat -v color"
+end tell'
+```
+
+### Login in to your app
+
+```sh
+$adb_path -s $adb_id
+	shell input text "[email protected]"
+	&& $adb_path -s $adb_id shell input tap 500 600
+	&& $adb_path -s $adb_id shell input text "password"
+```
+
+_This might need some tweaking to fit your app_
+
+### Wipe emulator data
+
+```sh
+$android_home_path/emulator/emulator @$device_name -wipe-data
+```