Skip to main content

Adbnik — one desktop app for ADB, SSH, serial, device files, and USB screen control.

Project description

Adbnik

Adbnik is a desktop control room for Android and embedded work: ADB shell tabs, SSH sessions, serial (COM) consoles, device and remote file browsing, and USB screen mirroring (via scrcpy or another tool you install)—in one window with tabs and bookmarks.

It is not made by Google. It does not bundle ADB, OpenSSH, or scrcpy. Install those yourself (or use existing installs) and set paths under File → Preferences if they are not on your PATH.


What you can do

Goal In Adbnik
Shell, install, device commands ADB: pick a device, open shell tabs, bookmarks and shortcuts.
Remote servers SSH tabs using the ssh client on your PATH.
Boards / firmware logs over COM Serial: port and baud in the same UI.
Files on phone or server File explorer workflows (Android / remote).
Mirror the device screen on PC Screen: launch your mirroring tool (e.g. scrcpy).

Before you install

  • Python 3.9+ (64-bit recommended on Windows).
  • Platform-tools (ADB) on PATH, USB debugging on the device.
  • OpenSSH client (ssh) on PATH for SSH tabs.
  • scrcpy (or similar) for mirroring, on PATH or set in Preferences.
  • COM hardware + driver for serial.

Install

Use the same Python for pip and for running the app. On Windows this avoids broken Scripts\adbnik.exe installs.

Recommended:

py -m pip install --upgrade pip
py -m pip install adbnik
py -m adbnik

If you use a specific Python (example: C:\Python\python.exe):

C:\Python\python.exe -m pip install --upgrade pip
C:\Python\python.exe -m pip install adbnik
C:\Python\python.exe -m adbnik

Always prefer python -m adbnik if double-clicking adbnik.exe ever fails.


First run

  1. Start the app with py -m adbnik (or your python -m adbnik).
  2. Set ADB / scrcpy paths in File → Preferences if not on PATH.
  3. Open ADB, SSH, Serial, Files, or Screen from the UI.

Settings: %USERPROFILE%\.adbnik.json. An older .devicedeck.json is migrated when you save.


Fix: ModuleNotFoundError: No module named 'adbnik'

The adbnik package is missing in the Python that runs your launcher (usually mixed pip / mixed Python).

C:\Python\python.exe -m pip uninstall adbnik -y
C:\Python\python.exe -m pip install --force-reinstall adbnik
C:\Python\python.exe -c "import adbnik; print(adbnik.__file__)"
C:\Python\python.exe -m adbnik

Use your\python.exe -m pip every time—not a different pip on PATH.

List interpreters: py -0p.


Development

git clone https://github.com/nvnkennedy/adbnik.git
cd adbnik
py -m venv .venv
.venv\Scripts\activate
py -m pip install -e ".[dev]"
py -m pytest tests -q
py -m adbnik

Windows .exe packaging: adbnik.spec, scripts/build_windows_exe.ps1, installers under installer/.


Links

Repository github.com/nvnkennedy/adbnik
PyPI pypi.org/project/adbnik
Site nvnkennedy.github.io/adbnik

Maintainer upload steps: docs/PYPI_PUBLISH.md.


License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adbnik-0.2.1.tar.gz (79.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adbnik-0.2.1-py3-none-any.whl (84.3 kB view details)

Uploaded Python 3

File details

Details for the file adbnik-0.2.1.tar.gz.

File metadata

  • Download URL: adbnik-0.2.1.tar.gz
  • Upload date:
  • Size: 79.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.8

File hashes

Hashes for adbnik-0.2.1.tar.gz
Algorithm Hash digest
SHA256 51d1058aac7c6ac5396598c17a4c91422dd7cca58cfddeac92b09a4effa5e044
MD5 9935d5b636cc31c444d304be8021173f
BLAKE2b-256 1bd0a8ac3fff8426c4c7f00274ab176ffe375ec58db958421c05a5a4d9d33f7d

See more details on using hashes here.

File details

Details for the file adbnik-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: adbnik-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 84.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.8

File hashes

Hashes for adbnik-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d6eec3bd46ecae35df3199c0d9e1a965769c70e9bacb2c573415da073468d0bc
MD5 25f3e6900f012ceb01c26f4a3fd359df
BLAKE2b-256 7c3c8461525e3da02f53ddb6fb7c205973f34cfc485271804644ab07d4e93cdc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page