Skip to main content

iOS device automation via the Nomix Clicker API — simulated touch input with AI screen recognition.

Project description

NomixClicker Scripting Library

This is a library of ready-made scripts written in Python and using the free Clicker API.

What Is Clicker?

NomixClicker is a controlling dongle for iOS. It allows manual control, automatic control via API, and fully autonomous AI mode.

Part of the features are work-in-progress, see the Roadmap.

Installation

Requires Python 3.10+. Install from PyPI:

pip install nomix-clicker

Buy a Clicker device if you don't have it (delivery takes ~2 weeks to any place in the world), then open the Panel and get your API token.

Purchase on the official site only.

Configuration

Provide your API token and device id in either of two ways (environment variables take precedence):

Environment variables:

export NOMIX_API_KEY="your-api-key"
export NOMIX_DEVICE_ID="your-device-id"

Or a config.json in your working directory or next to the script (copy config.example.json):

{
  "API_KEY": "your-api-key",
  "DEVICE_ID": "your-device-id",
  "API_URL": "https://panel.nomixclicker.com/clicker/v1"
}

Quick start

from nomix_clicker import Clicker, parse_screen, open_app, DEVICE_ID

clicker = Clicker(DEVICE_ID)
open_app(clicker, "Calculator")

screen = parse_screen(clicker)     # returns None on network/timeout errors
if screen:
    print(screen.description)      # what the AI recognizer sees on screen

Manual control of iPhones will work out-of-the-box, no setup needed.

Examples

Ready-made example scripts live in the examples/ folder of the repository (not included in the pip package — clone the repo to get them). With the package installed, run one directly:

python3 examples/notes.py

Start here:

  • notes.py - Safe, offline reference — opens the Notes app, creates a note, and types into it.
  • ai_agent.py - Runs an autonomous AI agent task with real-time progress streaming — the agent drives the device on its own.

Device utilities live in tools/ — ⚠️ these change connectivity or the stream; running them may drop the device's broadcast:

Local development

To work on the library itself, install it in editable mode:

pip install -e .

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

nomix_clicker-0.1.1.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

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

nomix_clicker-0.1.1-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file nomix_clicker-0.1.1.tar.gz.

File metadata

  • Download URL: nomix_clicker-0.1.1.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nomix_clicker-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3fb6c733f0d6ca0e2871226bc82c8f74406516d5d2ecdba23af6e5488960d58f
MD5 7e2a7559057e4a8d61268c7a320fdb4f
BLAKE2b-256 959e56188ef47891129bf2cd0fbb47d65677cefee3576c6f41d2124cc2d8649c

See more details on using hashes here.

Provenance

The following attestation bundles were made for nomix_clicker-0.1.1.tar.gz:

Publisher: publish.yml on nomix-ai/ClickerScriptingLibrary

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

File details

Details for the file nomix_clicker-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: nomix_clicker-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nomix_clicker-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eb1206582a96a23ad0da2da532b4520de8e6a842727308b6bcac19015bac9c7c
MD5 ae15959b7849fb8d644d73538c3b24f5
BLAKE2b-256 1565d2a9672f210cdce836d1366a0d2d4e71d8ab70b6161ab4fe698f4186466a

See more details on using hashes here.

Provenance

The following attestation bundles were made for nomix_clicker-0.1.1-py3-none-any.whl:

Publisher: publish.yml on nomix-ai/ClickerScriptingLibrary

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