Skip to main content

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

Project description

Adbnik

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.6.tar.gz (80.3 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.6-py3-none-any.whl (85.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: adbnik-0.2.6.tar.gz
  • Upload date:
  • Size: 80.3 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.6.tar.gz
Algorithm Hash digest
SHA256 a12f4950615cb0ae9e8e394a189013d219cd2c26a9ba4d48dcd57ca896125a43
MD5 65988ec67c3899f3ad58a60358f8554e
BLAKE2b-256 d4e338cd203bc27430280ef10c6e989866a05b5fcb4cd8642fa3e9a928a50bfc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: adbnik-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 85.1 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 40136ea393eee2a89bce9519b4a964c48c5c71a6c75d45aebcba2a5f5142819f
MD5 edd422264e38a37de6db3ee5fed3cf37
BLAKE2b-256 ba6626164bb07dd2273acc05d4a52f41d6bf4ca748a650d76bff06d9db902501

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