Skip to main content

PyQt5 desktop workspace for Android ADB, SSH/serial terminals, SFTP/FTP file transfer, and screen-mirroring integration.

Project description

Adbnik

Adbnik

One desktop workspace for Android debugging, remote shells, and file operations.

Adbnik is a PyQt5 application that brings ADB workflows, SSH and serial terminals, local ↔ remote file management (Android device, SFTP, FTP), and screen mirroring launchers (e.g. scrcpy) into a single tabbed window. External tools—adb, ssh, scrcpy—are used from your system: install them separately and, if needed, set paths under File → Preferences.

About the name

Adbnik combines ADB (Android Debug Bridge) with -nik, a productive-form suffix familiar from words like technik (technician; someone who works with tools). It signals a utility focused on hands-on device work—not a generic “suite,” but a workstation built around real debugging and transfer tasks.


Capabilities

Area Details
ADB Device selection, shell sessions, APK install flow, bookmarks, quick actions
SSH Full-screen terminal via your system OpenSSH client
Serial COM port and baud configuration in the UI
Files Dual-pane explorer: local disk ↔ Android / SFTP / FTP
Screen Start and manage mirroring using your chosen executable

User guide

Step-by-step documentation for the Terminal, File Explorer, and Screen Control tabs (menus, toolbars, keyboard shortcuts, and scrcpy options), plus where to put adb / scrcpy on disk:

https://nvnkennedy.github.io/adbnik/guide/

In the app: Help → User guide (F1) opens the same URL; Help also lists the website, GitHub, and PyPI.


Requirements

  • Python 3.9+ (64-bit recommended on Windows)
  • Android: USB debugging enabled; platform-tools (adb) available to the same environment that runs Adbnik
  • SSH: ssh on PATH (or wherever your shell resolves it)
  • Mirroring: scrcpy or another tool—PATH or Preferences
  • Serial: Port visible to the OS with the correct driver

Installation

Use the same Python interpreter for pip and for launching (avoids broken entry points on Windows):

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

Pinned interpreter example:

"C:\Path\To\Python\python.exe" -m pip install adbnik
"C:\Path\To\Python\python.exe" -m adbnik

Package index: pypi.org/project/adbnik

Shortcut (Windows)

pip cannot place shortcuts or ask for a folder. After installing, run once on Windows:

adbnik-setup

A folder dialog opens (starting on your Desktop); choose where to put Adbnik.lnk. No extra console window is shown—only the dialogs. The shortcut uses this Python (python -m adbnik) and the same app icon as the window. Icon files are cached under %LOCALAPPDATA%\Adbnik\.

Non-interactive example (e.g. script or batch file, with console output):

adbnik-setup --folder "%USERPROFILE%\Desktop"

First run

  1. Start the app: python -m adbnik from the environment where the package is installed.
  2. Under File → Preferences, set paths for ADB and scrcpy if they are not on PATH.
  3. Use the main tabs for Terminal, Files, and Screen as needed.

Preferences are stored in .adbnik.json under your user profile. Legacy .devicedeck.json settings are migrated when you save preferences.


Screenshots

Main window

Terminal

File explorer

Screen control


Troubleshooting

ModuleNotFoundError: No module named 'adbnik' — Install and run with the same python.exe:

"C:\Path\To\Python\python.exe" -m pip install --force-reinstall adbnik
"C:\Path\To\Python\python.exe" -m adbnik

On Windows, list interpreters with py -0p.


Resources

Product site nvnkennedy.github.io/adbnik — overview and links
User guide nvnkennedy.github.io/adbnik/guide/ — Terminal, File Explorer, Screen Control
Source code github.com/nvnkennedy/adbnik
Releases GitHub Releases

Building from source

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

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-1.3.1.tar.gz (544.5 kB view details)

Uploaded Source

Built Distribution

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

adbnik-1.3.1-py3-none-any.whl (144.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for adbnik-1.3.1.tar.gz
Algorithm Hash digest
SHA256 852dd9f2f299f67d2a9e813611a7691e6e8294a8a979eb3aaeb5a10b28bb8721
MD5 29e33e3149de85aa7ed6709fbbee1ff3
BLAKE2b-256 e87e75b91de5c8dde4f152c0d0401638c93ee63e7735f3437502f1c636b03a69

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for adbnik-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c7ff6cf8603289c47746508cb913365ff924a34bc4f5c835d56c0f425a9f03c2
MD5 80304d71abce70e00aa02cdce0622c59
BLAKE2b-256 ab5d16c62bdad1dce2163c9e905b1914ec0a943830b2317b58a488b8bd165b14

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