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 installation, use that interpreter for both pip and adbnik:

"C:\Path\To\Python\python.exe" -m pip install --upgrade pip
"C:\Path\To\Python\python.exe" -m pip install adbnik
"C:\Path\To\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 python -m adbnik from the environment where you installed the package).
  2. Set ADB / scrcpy paths in File → Preferences if not on PATH.
  3. Open ADB, SSH, Serial, Files, or Screen from the UI.

Settings are stored in a .adbnik.json file under your user profile. If you previously used an older config named .devicedeck.json, it is migrated when you save preferences.


Fix: ModuleNotFoundError: No module named 'adbnik'

The package is not installed for the same Python that runs your command or shortcut (often mixed pip / mixed Python). Reinstall using that interpreter:

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

Use python.exe -m pip for the same python.exe you use to run the app—not a different pip on PATH.

On Windows, list interpreters: py -0p.


Development

From a clone of this repository:

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

Optional Windows installers or other distribution formats may be published via GitHub Releases or the project site (see links below)—not part of the PyPI package.


Links

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

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.5.tar.gz (80.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.5-py3-none-any.whl (85.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: adbnik-0.2.5.tar.gz
  • Upload date:
  • Size: 80.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.5.tar.gz
Algorithm Hash digest
SHA256 970dd5f3264c1762cd24738e3673299c8b9823b2038938d9eaca9bea8e838b7d
MD5 a209ada24b0b81a564b1ba10d49e8745
BLAKE2b-256 8accf1c910fb68b79e5db90cd0c706815908bc21404fab5fd97395281b4a6398

See more details on using hashes here.

File details

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

File metadata

  • Download URL: adbnik-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 85.0 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 74863f717849c97baa21c8c71868d70996e0096e4eda382999cf6deece96f12e
MD5 67d0ae00d8f36f785e89dcdd14da8083
BLAKE2b-256 5ef6825debbcc938017fbd47e9c335d32209ebd7fe351ae5ac4aea2ff4d1f81f

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