meshcorectl

This is an AI-generated application. The design, code, tests, and documentation in this repository were produced by an AI coding agent (Claude), directed and reviewed by a human maintainer.

A non-interactive, kubectl-style CLI for MeshCore companion radios: meshcorectl VERB [TYPE] [NAME] [flags], named connection contexts (BLE/serial/TCP), and -o table|json|yaml|wide|name output on every read command.

For design rationale and architecture, see PLAN.md.

Install

pip install -e ".[dev]"    # from a checkout, until this is published

Quickstart

# Point a named context at your device (BLE, serial, or TCP)
meshcorectl config set-context home --ble-address AA:BB:CC:DD:EE:FF
meshcorectl config use-context home

# Read
meshcorectl get contacts
meshcorectl get contact alice -o yaml
meshcorectl describe device
meshcorectl logs -f

# Write
meshcorectl send message alice "hello"
meshcorectl create channel 1 "#general"
meshcorectl delete contact -l 't=client,u>30d'   # -l selectors batch across matches

# Shell completion
source <(meshcorectl completion bash)   # or zsh / fish

Every command has real --help text; docs/command-reference.md is the same text generated into one file. Nothing here is interactive — no REPL, no prompts on the happy path (an exception: login without --password/--password-stdin prompts securely for one, the same as ssh or git) — every command is a single invocation that connects, does one thing, and exits, which is what makes it scriptable.

Status

Every command in this README is implemented and tested. A background-agent daemon for low-latency repeated invocations (meshcored) is planned but not yet built.

Development

python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
pytest                # 100% line+branch coverage enforced
ruff check .
mypy

After adding or changing a command, regenerate the reference doc:

python3 scripts/generate_command_reference.py

A test (tests/unit/test_command_reference.py) fails if it's out of date.

License

MIT — same license as the original meshcore-cli.

Project links

Data verified by PyPI on Sep 12, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for wbcanterbury from gravatar.com wbcanterbury

Credits

Author: William Canterbury

GitHub Statistics

Data verified by PyPI on Sep 12, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Provides Extra

dev

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meshcorectl-0.1.0.tar.gz (72.8 kB view details)

Uploaded Source

Built Distribution

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

meshcorectl-0.1.0-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

Details for the file meshcorectl-0.1.0.tar.gz.

File metadata

  • Download URL: meshcorectl-0.1.0.tar.gz
  • Upload date:
  • Size: 72.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for meshcorectl-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c2b4dbb659122b35d8658a2e3f9e8e9d44677d2a3d3c982dba8043b4f4d57d68
MD5 00e6c3eb0274e6e849f67cd3be81620b
BLAKE2b-256 bf149f79ae744c69a5c962d7f2ca249aa048fe6143db834f3a09b90cd832f8a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for meshcorectl-0.1.0.tar.gz:

Publisher: ci.yml on Faradome/meshcorectl

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

File details

Details for the file meshcorectl-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: meshcorectl-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 49.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for meshcorectl-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0b7f15b149b718b7a9290e710d265d5b75a3021b5116294c791e62fb424c9c7
MD5 e8610bd25d5b1899acb6f57604956426
BLAKE2b-256 b3a727e81c9b7159e080b82e05446452470e27c77f650d4c873ef6ee243ed654

See more details on using hashes here.

Provenance

The following attestation bundles were made for meshcorectl-0.1.0-py3-none-any.whl:

Publisher: ci.yml on Faradome/meshcorectl

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

Release history Release notifications | RSS feed

0.1.1

2 files

This release

0.1.0 This release

2 files

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