Metadata-Version: 2.4
Name: boardex
Version: 0.1.0
Summary: Boardex in one command: `boardex up` launches the runner with the UI embedded.
Project-URL: Homepage, https://github.com/ankayca/boardex
Project-URL: Source, https://github.com/ankayca/boardex
Author: Boardex contributors
License-Expression: Apache-2.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Embedded Systems
Requires-Python: >=3.10
Requires-Dist: boardex-core==0.1.0
Requires-Dist: boardex-logic==0.1.0
Requires-Dist: boardex-runner[agent]==0.1.0
Requires-Dist: boardex-target==0.1.0
Provides-Extra: dev
Requires-Dist: hatchling>=1.24; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Description-Content-Type: text/markdown

# boardex

Boardex in one command. `boardex up` launches the runner with the dashboard embedded and
serves both from a single origin; `boardex up --demo` replays a recorded bring-up run that
needs no hardware and no API key; `boardex doctor` reports what this machine is missing,
with the fix for each item.

```bash
pipx install boardex     # available after the first release
boardex up --demo
```

**Full documentation:**

- [Getting Started](https://github.com/ankayca/boardex/blob/main/docs/GETTING_STARTED.md)
  — install (including the pre-release form), the demo, your first run, adding hardware,
  troubleshooting.
- [Project README](https://github.com/ankayca/boardex/blob/main/README.md) — what Boardex
  is, and how to work from a checkout.

This package is a launcher. The work is done by four sibling packages — `boardex-core`,
`boardex-logic`, `boardex-target`, `boardex-runner[agent]` — which release in lockstep with
it. They resolve as `==<version>` pins by default (the publishable form); set
`BOARDEX_LOCAL_SIBLINGS=1` to resolve them against a checkout's `servers/` tree instead,
which is what the from-source install needs.
