unifi-cli 0.0.4__py3-none-win_amd64.whl

unifi_cli/__init__.py

@@ -0,0 +1,10 @@
+"""
+unifi-cli: CLI for UniFi Network controller.
+"""
+
+try:
+    from importlib.metadata import version
+    __version__ = version("unifi-cli")
+except ImportError:
+    from importlib_metadata import version
+    __version__ = version("unifi-cli")

unifi_cli/__main__.py

@@ -0,0 +1,52 @@
+"""
+Command-line interface for unifi-cli.
+"""
+
+from __future__ import annotations
+
+import os
+import sys
+import subprocess
+from pathlib import Path
+
+
+def find_native_binary() -> str:
+    """Find the native Rust binary."""
+    project_root = Path(__file__).resolve().parent.parent
+    target_binary = project_root / "target" / "release" / "unifi-cli"
+    if target_binary.exists() and not target_binary.is_dir():
+        return str(target_binary)
+
+    if sys.platform == "win32":
+        target_binary = project_root / "target" / "release" / "unifi-cli.exe"
+        if target_binary.exists() and not target_binary.is_dir():
+            return str(target_binary)
+
+    raise FileNotFoundError(
+        "Could not find the native unifi-cli binary. "
+        "Please ensure it was built with 'cargo build --release'."
+    )
+
+
+def main() -> int:
+    """Run the unifi-cli command line tool."""
+    try:
+        native_binary = find_native_binary()
+        args = [native_binary] + sys.argv[1:]
+
+        if sys.platform == "win32":
+            completed_process = subprocess.run(args)
+            return completed_process.returncode
+        else:
+            os.execv(native_binary, args)
+            return 0
+    except FileNotFoundError as e:
+        print(f"Error: {e}", file=sys.stderr)
+        return 1
+    except Exception as e:
+        print(f"Error: {e}", file=sys.stderr)
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())

unifi_cli-0.0.4.dist-info/METADATA

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: unifi-cli
+Version: 0.0.4
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: System :: Networking
+License-File: LICENSE
+Summary: CLI for UniFi Network controller
+Home-Page: https://github.com/rvben/unifi-cli
+Author-email: "Ruben J. Jongejan" <ruben.jongejan@gmail.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/rvben/unifi-cli
+Project-URL: Repository, https://github.com/rvben/unifi-cli.git
+
+# unifi-cli
+
+CLI for UniFi Network controller. Designed for both human operators and AI agents.
+
+## Installation
+
+### From source
+
+```bash
+cargo install unifi-cli
+```
+
+### From GitHub releases
+
+Pre-built binaries are available for Linux (x64, arm64), macOS (x64, arm64), and Windows (x64) on the [releases page](https://github.com/rvben/unifi-cli/releases).
+
+## Configuration
+
+Configuration can be provided via CLI flags, environment variables, or a config file.
+
+### CLI flags
+
+```bash
+unifi-cli --host https://unifi.example.com --api-key YOUR_KEY clients list
+```
+
+### Environment variables
+
+```bash
+export UNIFI_HOST=https://unifi.example.com
+export UNIFI_API_KEY=YOUR_KEY
+unifi-cli clients list
+```
+
+### Config file
+
+Create `~/.config/unifi-cli/config.toml`:
+
+```toml
+host = "https://unifi.example.com"
+api_key = "YOUR_KEY"
+```
+
+## Usage
+
+### Clients
+
+```bash
+unifi-cli clients list                          # List connected clients
+unifi-cli clients show aa:bb:cc:dd:ee:ff        # Show client details
+unifi-cli clients block aa:bb:cc:dd:ee:ff       # Block a client
+unifi-cli clients unblock aa:bb:cc:dd:ee:ff     # Unblock a client
+unifi-cli clients kick aa:bb:cc:dd:ee:ff        # Disconnect a client
+unifi-cli clients set-fixed-ip MAC IP [--name]  # Set DHCP reservation
+```
+
+### Devices
+
+```bash
+unifi-cli devices list                          # List network devices
+unifi-cli devices restart aa:bb:cc:dd:ee:ff     # Restart a device
+unifi-cli devices locate aa:bb:cc:dd:ee:ff      # Blink locate LED
+unifi-cli devices locate aa:bb:cc:dd:ee:ff --off  # Stop blinking
+```
+
+### Networks
+
+```bash
+unifi-cli networks                              # List all networks
+```
+
+### System
+
+```bash
+unifi-cli system health                         # Show subsystem health
+unifi-cli system info                           # Show controller info
+```
+
+## Agent-friendly design
+
+unifi-cli is designed to work well with AI agents and automation scripts. Instead of requiring an MCP server, agents can call the CLI directly with lower overhead and better composability.
+
+### Automatic JSON output
+
+When stdout is not a terminal (piped or redirected), output switches to JSON automatically. No flags needed.
+
+```bash
+# Human at terminal: gets a formatted table
+unifi-cli clients list
+
+# Agent piping output: gets JSON automatically
+data=$(unifi-cli clients list)
+```
+
+You can also force JSON mode explicitly:
+
+```bash
+unifi-cli --json clients list
+```
+
+### Clean stdout/stderr separation
+
+Data goes to stdout. Human messages (summaries, confirmations) go to stderr. This means piping and redirection always capture clean, parseable data.
+
+```bash
+# stdout has only the JSON data, stderr has "12 clients"
+unifi-cli clients list > clients.json
+```
+
+### Quiet mode
+
+Suppress all non-data output with `--quiet`:
+
+```bash
+unifi-cli --quiet clients list    # No summary line on stderr
+```
+
+### Structured mutation responses
+
+Commands that change state (block, kick, restart, etc.) return structured JSON:
+
+```bash
+unifi-cli --json clients block aa:bb:cc:dd:ee:ff
+# {"action": "block", "mac": "AA:BB:CC:DD:EE:FF", "status": "ok"}
+```
+
+### Runtime schema introspection
+
+The `schema` command dumps all commands, arguments, output fields, and exit codes as JSON. Agents can discover capabilities at runtime without parsing `--help` text.
+
+```bash
+unifi-cli schema
+```
+
+This outputs the full command tree including which commands are mutating, what arguments they accept, and what fields appear in the JSON output.
+
+### Distinct exit codes
+
+Agents can branch on specific failure modes without parsing error messages:
+
+| Code | Meaning |
+|------|---------|
+| 0 | Success |
+| 1 | General error |
+| 2 | Configuration error (missing host or API key) |
+| 3 | Authentication error (401/403) |
+| 4 | Not found (404) |
+| 5 | API error (server error) |
+
+### Why CLI over MCP?
+
+For AI agent integrations, a well-designed CLI has several advantages over an MCP server:
+
+- **Token efficiency** -- a CLI call uses ~35x fewer tokens than the MCP tool-call protocol
+- **Composability** -- pipe output to `jq`, `grep`, or other tools
+- **No server process** -- no sidecar to run, no port to manage
+- **Universal** -- works from any language, shell, or automation framework
+
+## Development
+
+```bash
+make check      # Lint and test
+make test       # Run tests
+make install    # Build and install to ~/.local/bin
+```
+
+## License
+
+MIT
+

unifi_cli-0.0.4.dist-info/RECORD

@@ -0,0 +1,8 @@
+unifi_cli/__init__.py,sha256=mxTST28R42dvCYtJy5l7PZkps696B4E_9X3zQNQw5kA,253
+unifi_cli/__main__.py,sha256=QkjbxdgqykyrS94JwstDVcNdgXO4RecJ9L41koBRxeE,1491
+unifi_cli-0.0.4.data/scripts/unifi-cli.exe,sha256=3Q2y-sh9FrYePiNMdH5WebaIKKh3DO8wgDnHPC6RtaM,5531648
+unifi_cli-0.0.4.dist-info/METADATA,sha256=rpaokG5dnnHJLjyUWPIxCbiBx2OtqrCTdI2vmdpxGrk,5377
+unifi_cli-0.0.4.dist-info/WHEEL,sha256=uJOc2U-Q1x95AlblQcqMRb3iR4QnPtdI7X2ycPN99rM,94
+unifi_cli-0.0.4.dist-info/licenses/LICENSE,sha256=YyJnikhAW7_HwaUPeO-iJud1fh2UplNX6MZP1zd1OXY,1092
+unifi_cli-0.0.4.dist-info/sboms/unifi-cli.cyclonedx.json,sha256=pL2EsLdfdeMhPzSKldARPJRyBKUZhr58OzT467dwI9M,199878
+unifi_cli-0.0.4.dist-info/RECORD,,

unifi_cli-0.0.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.12.6)
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

unifi_cli-0.0.4.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ruben Jongejan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.