Skip to main content
iptime-cli: a router reached from a terminal

iptime-cli

한국어

An unofficial CLI and Python library for reading and changing ipTIME routers that run the new firmware 16.x admin UI.

Python 3.9+ · no dependencies

pypi license

Install · Quick start · Why

iptime-cli lists made-up router clients and previews a port-forwarding change

Install

$ pipx install iptime-cli
$ uv tool install iptime-cli

Python 3.9 or newer. The package uses only the standard library.

Quick start

Set IPTIME_HOST, IPTIME_USER and IPTIME_PASSWORD, or save them in the config file. Try the commands below against the bundled fake router before connecting real hardware.

$ iptime clients
IP            MAC                NAME        LINK          LEASE LEFT  RESERVED
192.168.0.10  AA:BB:CC:00:00:01  desktop     lan2 wired    static
192.168.0.11  AA:BB:CC:00:00:02  nas         lan4 wired    22h 13m     yes
192.168.0.20  AA:BB:CC:00:00:03  laptop      5g.1 -48 dBm  1h 46m

$ iptime info
Model            ipTIME FAKE-1000
Firmware         16.000  (built 2026.01.01 00:00:00)
Latest firmware  16.010  (update available)
Uptime           1d 2h 3m
LAN              192.168.0.1 / 255.255.255.0
DHCP pool        192.168.0.2 - 192.168.0.254
WAN              dhcp 203.0.113.7  gateway 203.0.113.1  up
WAN link         1000f

$ iptime port add "Game server" --target 192.168.0.10 --ext 25565 --dry-run
dry run, nothing sent:
POST http://127.0.0.1:18180/cgi/service.cgi
{"method": "portforward/add", "params": {"name": "Game server", "active": true, "protocol": "tcp", "target": "192.168.0.10", "src": {"start": 25565}, "dst": {"start": 25565}}}

The fake router serves fixed, invented devices on localhost. Start it with python -m iptime_cli.fake_router --port 18180, then set IPTIME_HOST=127.0.0.1:18180 and IPTIME_PASSWORD=secret.

iptime-cli sends commands to the router API and returns readable output; dry-run previews a write

Why

The firmware 16.x admin UI talks to the router through a JSON endpoint. iptime-cli uses that endpoint for terminal commands and Python calls; it does not support the older firmware 14.x UI or other router brands.

Read commands do not change router settings. Write commands show a confirmation or accept --dry-run; in non-interactive use they require --yes. Login may end an admin session open in a browser. A firmware upgrade reboots the router and interrupts the network.

Commands

Command Reads or changes
iptime info, clients, wan, wifi Router and connection status
iptime dhcp list, port list Existing leases, reservations and forwarding rules
iptime dhcp reserve, port add, port rm DHCP and forwarding settings
iptime remote-admin, firmware check Remote access and firmware status
iptime call, iptime methods Raw API methods and their recorded status

Add --json to read commands for scripts. Wi-Fi passwords are hidden unless you pass --show-secrets. The Python API starts with Router(host, user, password).call(method, params).

Limits

The supported admin UI is firmware 16.x. Commands have been exercised with the bundled fake router; router models and firmware variants are listed in the project’s method catalog. Do not infer a router’s state after a failed connection.

Contributing

Issues and pull requests are welcome. See CONTRIBUTING.md for the fake router, the regression tests and the review process.

License

MIT. This unofficial project is not affiliated with, endorsed by or supported by EFM Networks. ipTIME is its trademark.

Metadata

Release files for iptime-cli 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iptime-cli 0.1.4
File Size Uploaded Provenance Actions
iptime_cli-0.1.4.tar.gz 31.7 kB Without provenance Details for iptime_cli-0.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for iptime-cli 0.1.4
File Interpreter ABI Platform Actions
iptime_cli-0.1.4-py3-none-any.whl Python 3 none any Details for iptime_cli-0.1.4-py3-none-any.whl

Total release size: 61.8 kB

Release files / iptime_cli-0.1.4.tar.gz

Download URL iptime_cli-0.1.4.tar.gz
Size 31.7 kB
Tags Source
SHA-256 checksum
How to use checksums
3c9c9ee0f285d6141b9c850a6cdf91b0a973bb1d42d3431a6d2064b66d6bc2c3
BLAKE2b-256 checksum
How to use checksums
55994174b66181b2efac57b4f347b9c7a2a28158d35ed5c53fcb82117ba08769
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.8

Release files / iptime_cli-0.1.4-py3-none-any.whl

Download URL iptime_cli-0.1.4-py3-none-any.whl
Size 30.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7bc662f8db777540c9e51d3247bb5ddf7ca633ddb21b91c9cc551cd5b8032738
BLAKE2b-256 checksum
How to use checksums
d055e9db3140f09485e3681b574e0e2e2ac877e35ea3af1909f1cd7336ee796d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.8

Security for iptime-cli 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page