Merge pull request #265 from anusha-c18/dev-tools

feat: add docs for developer tools
canonical · Jan 16, 2025 · c88fabb · c88fabb
2 parents a9c729b + ce31310
commit c88fabb
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/.custom_wordlist.txt b/.custom_wordlist.txt
@@ -241,6 +241,7 @@ Renderdoc
 renderdoc
 renderer
 RenderThread
+resizable
 RESTful
 RFE
 RGBA
@@ -292,6 +293,7 @@ swiftshader
 swrast
 syscall
 syscalls
+syslog
 systemd
 telegraf
 tooltip
@@ -307,6 +309,7 @@ UA
 UDA
 UDP
 UI
+undocked
 unencrypted
 unexpose
 unhandled

diff --git a/howto/application/stream-application.md b/howto/application/stream-application.md
@@ -63,6 +63,22 @@ To share your stream with users without an account, click *Set up sharing* ( ![s
 
 Set your stream title and expiration details and generate a link that can be shared with others.
 
+### Developer Tools
+
+Toggle the *Developer Tools* panel on the *Stream* page to interact with your Android stream and monitor its performance. It helps you to track resource usage, view logs, and perform various actions while interacting with your Android stream in real-time to enhance your workflow. This panel is resizable, allowing you to customise your layout as needed, and can also be undocked into a separate window.
+
+The *Terminal* tab allows you to interact with the *Ubuntu* terminal and the *Android* terminal.
+
+The *Ubuntu* terminal is a bash shell on the Ubuntu instance hosting Anbox Cloud, where you can run commands such as `top` to monitor system processes in real-time or `free -h` to check memory usage. Other starter commands are listed within the terminal for your reference.
+
+The *Android* terminal provides shell access to the Android operating system, allowing you to perform actions equivalent to having ADB access. Commands such as `service list` to view running Android services or `pm list packages` to list packages can be executed here. Starter commands are also included for easy reference within the terminal.
+
+The *Logs* tabs allows you to view logs as you interact with your Android stream in real-time. It supports two types of logs: *logcat*, which displays Android-specific logs, and *syslog*, which displays system-wide logs.
+
+In the *Logs* tabs, you can toggle auto-scroll, pause and resume log messages, clear the logs, adjust the verbosity of the logs, search using free text search or regular expressions, and export the logs.
+
+For a detailed demonstration of the *Developer Tools* and their full capabilities, refer to: [Developer Tools](https://youtu.be/M1N8pfIUjOI?t=257&si=DJsoziD0NRTrLPff).
+
 ```
 ````