Skip to main content

A terminal-based Wi-Fi credential retriever and QR code generator.

Project description

WiFi QR Terminal

A Python CLI tool that retrieves your currently connected (or stored) Wi-Fi SSID and password, then generates a QR code directly in your terminal. This allows you to easily share your Wi-Fi connection with mobile devices without typing out long passwords.

Installation

pip install wifi-qr-terminal

Usage

Simply run:

wifi-qr

Options

  • --timeout <seconds>: Clears the screen and exits after the specified number of seconds. specific for security.
  • --no-color: Disable colored output (useful for some terminals).
  • --help: Show help message.
wifi-qr --timeout 30

OS Support & Permissions

The tool uses system commands to retrieve credentials.

Windows

Uses netsh.

  • generally works without Admin if checking the currently connected profile or profiles owned by the user.
  • If it fails, try running the terminal as Administrator.

macOS

Uses security and networksetup.

  • You will likely see a system popup asking for permission to access the Keychain to retrieve the Wi-Fi password. This is normal macOS security behavior.
  • Click "Allow" to proceed.

Linux

Uses nmcli (NetworkManager).

  • Typically does not require sudo if the user has permissions to view network secrets, but on some systems/distros, you might need to run:
    sudo wifi-qr
    

Security Note

Passwords are displayed on screen (encoded in the QR). Be aware of your surroundings when running this tool. Use the --timeout feature to minimize exposure time.

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

wifi_qr_terminal-0.1.2.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

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

wifi_qr_terminal-0.1.2-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file wifi_qr_terminal-0.1.2.tar.gz.

File metadata

  • Download URL: wifi_qr_terminal-0.1.2.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for wifi_qr_terminal-0.1.2.tar.gz
Algorithm Hash digest
SHA256 320799ce365586d1a7efd10d30a1681cc34879ab869f95fe58b0154595395a1f
MD5 f8bdc8165afe68a891a73607ee36f720
BLAKE2b-256 20310918c680c11028da33d9afd7b819f283b7feb41f0ba1dfae09213709897b

See more details on using hashes here.

Provenance

The following attestation bundles were made for wifi_qr_terminal-0.1.2.tar.gz:

Publisher: publish.yml on albizzy/wifi-qr-terminal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wifi_qr_terminal-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for wifi_qr_terminal-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4541bce9894457cf5c8f42230dfe6f57892a38bbde4112cc55d1d19cf4a51f79
MD5 943a373e047c965dfe4bf3b370c36070
BLAKE2b-256 6acb0ae1dae8241074faf3d4a26b1ad2d56469fabc96e98f1031aadb6896f3df

See more details on using hashes here.

Provenance

The following attestation bundles were made for wifi_qr_terminal-0.1.2-py3-none-any.whl:

Publisher: publish.yml on albizzy/wifi-qr-terminal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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