Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
afb3642
docs: specify LAN and mock defaults
Shakibuzzaman3104 Aug 17, 2026
2e8940b
docs: add LAN defaults implementation plan
Shakibuzzaman3104 Aug 17, 2026
24444f5
test: define LAN and mock defaults
Shakibuzzaman3104 Aug 17, 2026
8745c46
feat: default dashboard binding to LAN
Shakibuzzaman3104 Aug 17, 2026
cfe1d73
docs: describe LAN as the default binding
Shakibuzzaman3104 Aug 17, 2026
8760db6
docs: specify network detail search
Shakibuzzaman3104 Aug 17, 2026
98d54b9
docs: plan network detail search
Shakibuzzaman3104 Aug 17, 2026
c461273
feat: add network detail search matcher
Shakibuzzaman3104 Aug 17, 2026
71ed9fd
feat: improve network detail search
Shakibuzzaman3104 Aug 17, 2026
ebd34af
Merge branch 'main' into improve/improve-network-searching
Shakibuzzaman3104 Aug 17, 2026
e69c748
chore: drop Maven Central, distribute via JitPack only, bump to 1.2.2
Shakibuzzaman3104 Aug 17, 2026
26dd74b
feat: scope, step through, and expand matches in capture detail search
Shakibuzzaman3104 Aug 17, 2026
2bf722e
style: apply ktlintFormat and refresh the ui-compose API baseline
Shakibuzzaman3104 Aug 17, 2026
1d15246
refactor: clear the detekt findings the search feature introduced
Shakibuzzaman3104 Aug 18, 2026
6dc5858
fix: restore the AUTO binding default and cover the legacy coordinate
Shakibuzzaman3104 Aug 18, 2026
d850122
refactor: clear the review's minor findings
Shakibuzzaman3104 Aug 18, 2026
6891078
ci: publish the Gradle plugin from a tag, behind an approval gate
Shakibuzzaman3104 Aug 18, 2026
fa1c3a0
ci: publish on the tag itself, and pin the Gradle action
Shakibuzzaman3104 Aug 18, 2026
25eed33
ci: drop the dependency-review workflow
Shakibuzzaman3104 Aug 18, 2026
08daa99
fix: JitPack versions carry the v prefix, auto-wire included
Shakibuzzaman3104 Aug 18, 2026
2573067
docs: spell the JitPack placeholder as v<version>
Shakibuzzaman3104 Aug 18, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Ideally as a diff against one of the sample apps (`samples/compose-app`, `sample

- DevConsole module(s) and version(s) affected (e.g. `devconsole:0.1.0-SNAPSHOT`,
`devconsole-network-okhttp:0.1.0-SNAPSHOT`):
- Integration path: Maven Central coordinates, or built from source
- Integration path: JitPack coordinates, or built from source
(`./gradlew publishToMavenLocal`)?
- Android Gradle Plugin / Kotlin versions in the consuming project:
- Device/emulator API level and manufacturer:
Expand Down
16 changes: 0 additions & 16 deletions .github/workflows/dependency-review.yml

This file was deleted.

48 changes: 48 additions & 0 deletions .github/workflows/publish-plugin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Publish Gradle plugin

# A pushed `v*` tag is the release decision, so publishing follows it automatically. The guards
# below cover what a tag does not assert: that the version is the intended one and the suite passes.
on:
workflow_dispatch:
push:
tags: ['v*']

permissions:
contents: read

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/setup-java@v5
with:
distribution: temurin
java-version: '17'
# Pinned: this workflow holds the Portal credentials, so a moved tag upstream would run
# unreviewed code next to them. Bump deliberately.
- uses: gradle/actions/setup-gradle@9c971963bec38e04b3d30dcc455b5382be2fdbfb # v6.3.0

# A tag that disagrees with the plugin's own version would publish the wrong coordinate,
# and the Portal will not let it be corrected afterwards.
- name: Tag matches the plugin version
if: startsWith(github.ref, 'refs/tags/')
run: |
tag_version="${GITHUB_REF_NAME#v}"
declared="$(sed -n 's/^version = "\(.*\)"$/\1/p' gradle-plugin/build.gradle.kts)"
if [ "$tag_version" != "$declared" ]; then
echo "Tag $GITHUB_REF_NAME implies $tag_version but gradle-plugin declares $declared." >&2
exit 1
fi
echo "Publishing io.github.devconsole-android $declared"

- run: ./gradlew -p gradle-plugin test --stacktrace

- name: Publish to the Gradle Plugin Portal
run: >
./gradlew -p gradle-plugin publishPlugins --stacktrace
-Pgradle.publish.key="$GRADLE_PUBLISH_KEY"
-Pgradle.publish.secret="$GRADLE_PUBLISH_SECRET"
env:
GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
31 changes: 0 additions & 31 deletions .github/workflows/publish.yml

This file was deleted.

37 changes: 36 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,41 @@ before it can reach a release. (There was briefly a separate `sdk:plugin-api` mo
third-party plugin framework; it was removed before ever shipping — see Removed, below — so it never
joined this list.)

## 1.2.2 — 2026-08-17

### Added

- **Search inside a capture got scoping, stepping, and a full-screen reader.** Every detail screen
already filtered and highlighted as you typed; network captures now add arrows that step through
hits one at a time with a running `3/17` counter, a **Search in** chip that picks which sections
to match (defaulting to the request and response bodies), and a choice of matching field names,
values, or both. Any body can be expanded full-screen with a Formatted/Raw switch, a line count,
and a copy button. Note that matching *names* only works where the body has names — JSON does, a
raw or XML body does not — which is why the default matches both. All of this is `internal`; no
public API was added.

### Fixed

- **Simple mode never actually hid the dashboard's metric strips.** The rule was written against
`.metrics-strip` while the markup has always emitted `.metric-strip`, so the selector matched
nothing and Simple mode showed the full metric row regardless.

### Changed

- **JitPack is now the only distribution channel for the library artifacts.** Maven Central
publishing is removed: no `publishToMavenCentral`, no GPG signing, and no "Publish to Maven
Central" workflow. Consumers add `maven { url = uri("https://jitpack.io") }` to
`dependencyResolutionManagement` and switch the group from `io.github.devconsole-android` to
**`com.github.devconsole-android.DevConsole`**, and prefix the version with `v` (`v1.2.2`) —
JitPack serves a build under its git ref name and releases are tagged `v*`, so the bare version
does not resolve. Artifact IDs are unchanged.
Releasing is now just pushing a tag — JitPack builds the ref on first request.
- **The Gradle plugin still comes from the Gradle Plugin Portal** as `io.github.devconsole-android`,
because the `plugins { }` DSL cannot resolve a plugin marker from JitPack. Its variant-policy
check now recognises both the JitPack group and the old Central group, so an existing host that
still names `io.github.devconsole-android:devconsole` keeps its release-build protection; the
coordinate the plugin auto-wires is the JitPack one.

## 1.2.1 — 2026-08-17

Three default changes, aimed at the same complaint: a fresh integration showed a `127.0.0.1` URL
Expand Down Expand Up @@ -171,7 +206,7 @@ signing key — including JitPack, which this release adds as a channel.
- **JitPack as a secondary channel, for unreleased code.** Maven Central remains the supported
one; JitPack covers trying a branch or an unmerged fix. Artifacts resolve under the group
`com.github.devconsole-android.DevConsole` with the same artifact ids
(`com.github.devconsole-android.DevConsole:devconsole:1.1.1`), and any branch resolves as
(`com.github.devconsole-android.DevConsole:devconsole:v1.1.1` — the version is the git ref, so the `v` is part of it), and any branch resolves as
`<branch>-SNAPSHOT` (a `/` in the branch name is written `~`). Two limits worth knowing: the
Gradle plugin is **not** served there — it lives in an `includeBuild` and JitPack lists only the
31 library modules, so JitPack consumers name coordinates directly and give up the plugin's
Expand Down
116 changes: 68 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

**An in-app debugger for Android, with a browser dashboard for when you want a bigger screen.**

[![Maven Central](https://img.shields.io/maven-central/v/io.github.devconsole-android/devconsole)](https://central.sonatype.com/artifact/io.github.devconsole-android/devconsole)
[![JitPack](https://jitpack.io/v/devconsole-android/DevConsole.svg)](https://jitpack.io/#devconsole-android/DevConsole)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![minSdk 23](https://img.shields.io/badge/minSdk-23-3DDC84?logo=android&logoColor=white)](#compatibility)
[![CI](https://github.com/devconsole-android/DevConsole/actions/workflows/verify.yml/badge.svg)](https://github.com/devconsole-android/DevConsole/actions/workflows/verify.yml)
Expand All @@ -33,21 +33,34 @@ links no server code, and the Gradle plugin fails the build if the real runtime

## Quick start

**1. Add the plugin and two dependencies** to your app's `build.gradle.kts`:
**1. Add the JitPack repository** to your `settings.gradle.kts` — DevConsole is distributed through
[JitPack](https://jitpack.io/#devconsole-android/DevConsole):

```kotlin
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven { url = uri("https://jitpack.io") }
}
}
```

**2. Add the plugin and two dependencies** to your app's `build.gradle.kts`:

```kotlin
plugins {
id("com.android.application")
id("io.github.devconsole-android") version "1.2.1"
id("io.github.devconsole-android") version "1.2.2"
}

dependencies {
debugImplementation("io.github.devconsole-android:devconsole:1.2.1")
releaseImplementation("io.github.devconsole-android:devconsole-noop:1.2.1")
debugImplementation("com.github.devconsole-android.DevConsole:devconsole:v1.2.2")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-noop:v1.2.2")
}
```

**2. Open the inspector on the device.** The SDK auto-initializes on debuggable builds, so this
**3. Open the inspector on the device.** The SDK auto-initializes on debuggable builds, so this
works right away from any button in your debug UI:

```kotlin
Expand All @@ -70,7 +83,7 @@ SharedPreferences, SQLite, and files. Add one line to your HTTP client
(see [Wire up your network stack](#wire-up-your-network-stack)) and network, WebSocket, and MQTT
traffic show up too.

**3. Want a bigger screen? Start the browser dashboard.** Tap **Start server** on the inspector's
**4. Want a bigger screen? Start the browser dashboard.** Tap **Start server** on the inspector's
**More** screen and it hands you a connect URL and a QR code. You can also do it from code. Either
way your manifest needs `INTERNET`, which most apps already declare:

Expand All @@ -88,7 +101,7 @@ If it fell back — or if you passed `BindingMode.LOOPBACK` to keep it off the n
forward the port first:

```bash
adb forward tcp:8080 tcp:8080 # use the port from the DevConsole log line
adb forward tcp:8080 tcp:8080 # use the port from the loopback start's log line
```

Then open the **whole URL**. The `#code=` fragment is the credential, so a bare `http://host:port/`
Expand All @@ -105,6 +118,7 @@ gets you nothing.
|---|---|
| **In-app inspector** | `DevConsole.open(context)` shows every inspector below as an on-device screen (included with `devconsole`), plus a QR code for pairing the browser. Opens by shake (adjustable intensity) or draggable floating button via the opt-in `DevConsoleConfig.openTriggers` flags. Its More screen can also start and stop the dashboard server. |
| **Network inspector** | Every HTTP call with headers, bodies, and a DNS/TCP/TLS/send/wait/receive timing bar. Live-tails as traffic happens. |
| **Find in a capture** | Every detail screen has a find field that filters and highlights as you type. Network captures go further: step through hits with a counter and arrows, scope the search to the sections you choose, and match field names, values, or both. Any body can be expanded full-screen to read or copy. |
| **WebSocket & MQTT inspectors** | Connection lifecycles and every frame, inbound and outbound. MQTT rides the Eclipse Paho adapter. |
| **Mock rules** | Serve canned responses for matching requests (OkHttp), toggled from the dashboard, with deterministic priority matching. Wired by `installDevConsole` and editable out of the box. |
| **Request composer** | Make the device issue ad-hoc HTTP requests from the dashboard. Off by default, host-allowlist confinable. |
Expand Down Expand Up @@ -186,7 +200,9 @@ DevConsoleConfig.default().withBrowserConfig(BrowserConfig(binding = BrowserBind

// Require the network — fails loudly instead of falling back, and surfaces the
// ACCESS_LOCAL_NETWORK prompt on API 37+ devices:
DevConsoleConfig.default().withBrowserConfig(BrowserConfig(binding = BrowserBinding.LAN))
DevConsoleConfig.default().withBrowserConfig(
BrowserConfig(binding = BrowserBinding.LAN),
)
```

This is independent of the `bindingMode` you pass to `startBrowser` yourself; set both if you start
Expand Down Expand Up @@ -308,14 +324,37 @@ you can replay it, clone it into the composer, or flag it into a bug report:

<p align="center"><img src="docs/images/dashboard-network.png" width="820" alt="Network inspector in the browser dashboard, showing a captured request and response side by side" /></p>

### Search inside a capture

Every detail screen — a call, a frame, a push, a log line, a crash — has a find field at the top.
Type, and it filters the sections down to what matched and highlights the hits in place, with a
count so you know whether the thing you're looking for is here at all.

On **network captures** it goes further, because that's where you usually arrive with a specific
token in hand. Arrows step you through the hits one at a time with a running `3/17` counter, the
same motion as find-in-page, so you can hold an ID in your head and walk every place it appears.

Those captures also let you aim the search. Tap the **Search in** chip and you can pick which
sections to look at — it starts on the request and response bodies, since that's where most real
questions live — and choose whether to match field names, values, or both.

One thing worth knowing, because it's the kind of thing that costs an afternoon: matching *names*
only works where the body has names to match. JSON has them. A raw or XML body doesn't — it's
text all the way down — so a names-only search skips it entirely and quietly reports nothing.
That's why the default matches both, and why the sheet spells out what each mode will and won't
find.

Body too dense to read in a card? Expand it full-screen. You get the whole viewport, a
Formatted/Raw switch, a line count, and a copy button that puts the body on the clipboard.

### Set up Remote Config

Add the adapter — it is not part of the `devconsole` umbrella, so that Firebase never lands on the
classpath of an app that doesn't use it:

```kotlin
debugImplementation("io.github.devconsole-android:devconsole-remote-config-firebase:1.2.1")
releaseImplementation("io.github.devconsole-android:devconsole-remote-config-firebase-noop:1.2.1")
debugImplementation("com.github.devconsole-android.DevConsole:devconsole-remote-config-firebase:v1.2.2")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-remote-config-firebase-noop:v1.2.2")
```

> These two artifacts first ship in `1.2.0`; earlier versions do not have them.
Expand Down Expand Up @@ -365,8 +404,8 @@ anything sensitive in Remote Config.

## Artifacts

Group `io.github.devconsole-android`, one version for everything. There is deliberately no BOM, and
two coordinates cover a normal integration:
Group `com.github.devconsole-android.DevConsole`, one version for everything. There is deliberately
no BOM, and two coordinates cover a normal integration:

| Coordinate | Scope | What it is |
|---|---|---|
Expand All @@ -385,41 +424,22 @@ Opt-in add-ons (each `-noop` twin is the matching `releaseImplementation`):
| `devconsole-remote-config-firebase` | `devconsole-remote-config-firebase-noop` | Firebase Remote Config adapter (reflection-based; see [Remote Config](docs/REMOTE_CONFIG.md)) |

Everything else (`devconsole-core`, `devconsole-storage-room`, and the rest) arrives transitively.
You never name those. Every module publishes sources, javadoc, and a signed POM.

### JitPack (for unreleased code)

Maven Central is the supported channel: signed, versioned, and what the Gradle plugin resolves.
[JitPack](https://jitpack.io/#devconsole-android/DevConsole) sits alongside it for one job, which is
trying a branch or an unreleased fix before it ships. Add the repository to your **settings** file,
not the module:

```kotlin
dependencyResolutionManagement {
repositories {
mavenCentral()
maven { url = uri("https://jitpack.io") }
}
}
```

```kotlin
dependencies {
// Group is com.github.devconsole-android.DevConsole; artifact ids match the tables above.
debugImplementation("com.github.devconsole-android.DevConsole:devconsole:1.2.1")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-noop:1.2.1")
}
```

A release tag works as the bare tag, as above. Any branch works as `<branch>-SNAPSHOT`, with `/`
written as `~`, so a `feature/x` branch is `feature~x-SNAPSHOT`. JitPack support starts at
**1.1.1**; earlier tags do not build there. Three things to know before you rely on it:

- **The Gradle plugin is not on JitPack.** Only the 34 library artifacts are, so the
`plugins { id("io.github.devconsole-android") … }` block above does not apply. Name the
`debugImplementation` and `releaseImplementation` coordinates yourself. You also give up the
plugin's variant-policy check, which is the thing that keeps the full SDK out of release builds.
- **JitPack artifacts are unsigned.** Central's are signed; these are built on demand from a commit.
You never name those. Every module publishes sources, javadoc, and a POM.

### Versions and unreleased code

All 34 library artifacts come from [JitPack](https://jitpack.io/#devconsole-android/DevConsole),
which builds a ref on demand — so **the version is a git ref, spelled exactly as the ref is**.
Releases are tagged `v*`, which is why the coordinates above read `v1.2.2` and not `1.2.2`; the
bare form is a different ref and does not resolve. Any branch works as `<branch>-SNAPSHOT`, with
`/` written as `~`, so a `feature/x` branch is `feature~x-SNAPSHOT` — that is how you try an
unreleased fix before it ships. JitPack support starts at **v1.1.1**; earlier tags do not build
there. Two things to know:

- **The Gradle plugin comes from the Gradle Plugin Portal, not JitPack**, because the `plugins { }`
DSL cannot resolve a plugin marker from JitPack. That is why the quick start adds JitPack for
dependencies only; `plugins { id("io.github.devconsole-android") version "…" }` resolves from the
Portal with no extra repository configuration.
- **Snapshots move.** `-SNAPSHOT` follows the branch, so a build that worked can change under you.
Pin a tag for anything you keep.

Expand Down
Loading
Loading