Skip to main content

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.

Install

pip install meshcorectl

For a development checkout instead, see Development below.

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

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.1.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.1-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshcorectl-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 74ca1496bf065ab4592596d56ae957a29e50027040f19acc47ce5d3b705dad20
MD5 2268e466588c5e7d5cde5d57d7d795d5
BLAKE2b-256 14268d47ff69b819e56f658001843512b397e8f915c0eaf1b1790795617cfe9a

See more details on using hashes here.

Provenance

The following attestation bundles were made for meshcorectl-0.1.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: meshcorectl-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c6eb3560936dce8e8a2bc15e55c0873f29c75762d8e103fc867d030c1606dbf0
MD5 35c701e40b1d81b04eb9a15bbb96b541
BLAKE2b-256 a9d6591064fa1e1a4a440d6354dae4e2a0b8a0cf9f6c80e1d782f2faca201fe2

See more details on using hashes here.

Provenance

The following attestation bundles were made for meshcorectl-0.1.1-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

This release

0.1.1 This release

2 files

0.1.0

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