Skip to main content

edgelens-cli

Command-line interface for the EdgeLens Edge AI Device Farm. Drives the same EdgeLensClient as the Python SDK; useful for ad-hoc sessions, quick experiments, and shell scripts.

Install

pip install edgelens-cli
# or
pipx install edgelens-cli

Adds an edgelens executable to your PATH.

Quickstart

edgelens login            # prompts for the key; input is hidden
edgelens session create --device recamera-2002 --os stock-os --timeout 600
# session id is remembered as 'current' — follow-up commands target it
edgelens info
edgelens exec 'uname -a'
edgelens deploy ./face.cvimodel
edgelens inference run --duration 30
edgelens session release

In a script, pipe the key on stdin instead of passing it as an argument:

printf '%s\n' "$EDGELENS_API_KEY" | edgelens login

--json on the root command emits machine-readable JSON on every call, useful for shell pipelines or CI:

edgelens --json session create --no-wait | jq -r .id

Commands

edgelens login                            persist credentials (~/.edgelens/config.json)
edgelens logout                           forget credentials + current-session pointer
edgelens use <SESSION_ID>                 set current session for follow-up commands

edgelens session create [--device --os --timeout --wait/--no-wait]
edgelens session get [SESSION_ID]         defaults to current
edgelens session wait [SESSION_ID]        block until status=ready
edgelens session release [SESSION_ID]
edgelens session list                     recent sessions (from local state)

edgelens exec '<command>'                 run via SSH (proxied)
edgelens deploy <model_path> [--config --file ...]
edgelens info                             device info report
edgelens ssh                              print SSH connection details

edgelens display play <url> [--loop]
edgelens display show <url>
edgelens display stop
edgelens display status

edgelens inference start
edgelens inference stop
edgelens inference once
edgelens inference stats
edgelens inference run [--duration N --collect-frames]

Configuration

Source Used for
EDGELENS_API_KEY, EDGELENS_BASE_URL env vars Shell-session-scoped; the recommended way to pass a key in CI
--base-url flag One-off override
~/.edgelens/config.json (chmod 0600) Persistent default — set via edgelens login

Current-session state lives at ~/.edgelens/state.json (chmod 0600). Session ids touched in the last ten commands are kept under recent so edgelens session list shows what you were doing.

Develop

python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest

Metadata

Release files for edgelens-cli 0.2.2

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

Source distribution (sdist)

Source distribution for edgelens-cli 0.2.2
File Size Uploaded Provenance Actions
edgelens_cli-0.2.2.tar.gz 10.6 kB With provenance Details for edgelens_cli-0.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for edgelens-cli 0.2.2
File Interpreter ABI Platform Actions
edgelens_cli-0.2.2-py3-none-any.whl Python 3 none any Details for edgelens_cli-0.2.2-py3-none-any.whl

Total release size: 26.0 kB

Release files / edgelens_cli-0.2.2.tar.gz

Download URL edgelens_cli-0.2.2.tar.gz
Size 10.6 kB
Tags Source
SHA-256 checksum
How to use checksums
dce4fbc40c439e28f58ee2a319732fc2b45572ba156b6b54b8c6e7823a2ebf6f
BLAKE2b-256 checksum
How to use checksums
601f157d3d49e1c1036cadb6873cf891c89764b1d121fe6abe76e4215a103d85
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.

Transparency log

Release files / edgelens_cli-0.2.2-py3-none-any.whl

Download URL edgelens_cli-0.2.2-py3-none-any.whl
Size 15.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2b57b1fdda6ac0cb3136de2d4adac0d45a6810b8954dd7e8572e012a23057764
BLAKE2b-256 checksum
How to use checksums
d733461172efb264c9b15a4e0957e3a75cd4b469cae7eea5fb801c8bd0d3b3d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.

Transparency log

Security for edgelens-cli 0.2.2

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.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for edgelens_cli-0.2.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.

Transparency log

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.

Release history Release notifications | RSS feed

This release

0.2.2 This release

2 release files Full provenance

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