Command Reference¶
This page is for: people who want a quick map of the CLI without reading the full technical manual.
Before this page: User Guide Map if you are not sure which command family you need.
After this page: Technical Reference for deeper integration details.
Beginner-Friendly Entry Points¶
iints guide¶
Use this when you are not sure where to start.
iints start¶
Print a goal-based first-run plan, or run the safe starter action.
Common forms:
iints start
iints start --goal project --run
iints start --goal edge
iints start --goal data
iints demo¶
Zero-config first run.
Common forms:
iints demo
iints demo --full
iints demo --dry-run
iints quickstart¶
Create a ready-to-run project folder.
iints quickstart --project-name iints_quickstart
iints run --wizard¶
Interactive custom run builder.
Core Simulation Commands¶
iints run¶
Run one simulation.
Examples:
iints run --preset baseline_t1d
iints run --algo algorithms/example_algorithm.py --scenario scenarios/example_scenario.json
iints run --dry-run --preset baseline_t1d
iints run-full¶
One-line run with full output bundle.
iints run-parallel¶
Run a matrix of scenarios in parallel.
iints benchmark¶
Compare algorithms across standard workloads.
Extension Commands¶
iints plugin install¶
Install a local algorithm plugin without editing SDK source code.
iints plugin install algorithms/my_algo.py
iints algorithms list
The SDK copies the file into the local plugin home and records it in
~/.iints/plugins/registry.json. For tests or portable environments, set
IINTS_PLUGIN_HOME to another folder.
iints plugin register¶
Register extension files by kind.
iints plugin register algo algorithms/my_algo.py
iints plugin register patient-model patient_models/my_model.py --name "My Model"
iints plugin register data-source data_sources/my_importer.py
iints plugin register validator validators/my_check.py
Algorithm plugins become visible in iints algorithms list. Patient model,
data source, and validator plugins are registered for discovery/documentation
hooks so the SDK can grow without source-code edits.
iints plugin list¶
Show local extension plugins.
iints plugin list
iints plugin list --kind algorithm
iints plugin uninstall¶
Remove a local plugin registry entry.
iints plugin uninstall "My Algorithm"
iints plugin uninstall "My Algorithm" --remove-file
iints patientmodel list¶
Show built-in and locally registered patient models.
iints patientmodel list
Study / Research Commands¶
iints study-protocol¶
Write the official study protocol bundle.
iints run-study¶
Run the scientific benchmark matrix.
iints analyze¶
Aggregate a study directory.
iints compare-study¶
Compare two study outputs.
iints poster-study¶
Generate poster-ready figures from a study.
Data Commands¶
iints data list¶
Show public data packs.
iints data fetch¶
Fetch a pack into a local directory.
iints data certify¶
Run data certification.
iints data realism-check¶
Judge whether a glucose trace looks physiologically plausible for research or demo use.
iints import-carelink, iints import-nightscout, iints import-tidepool¶
Import real-world CGM sources.
Edge / Booth Commands¶
iints edge doctor¶
Preflight for Raspberry Pi or UNO Q.
iints edge setup¶
Generate an edge project scaffold.
iints edge deploy¶
Scaffold, upload, install, and start a Raspberry Pi edge project in one command.
iints edge offline-bundle¶
Build a USB-friendly offline install tarball for Raspberry Pi or UNO Q setups.
iints edge study¶
Run a reproducible multi-seed study directly on the current edge machine.
iints edge long-study¶
Run a multi-day or multi-week YAML-driven study directly on the Pi, with rolling day profiles and export-friendly nested outputs.
Use --resume to continue from the next incomplete day after a reboot.
iints edge study-snapshot¶
Create a .tar.gz snapshot of a long-study folder for crash recovery or USB backup.
iints edge study-export¶
Package a long-study folder into a transfer-ready zip archive for another device.
iints edge remote-status, iints edge remote-reset, iints edge remote-stop¶
Run common Raspberry Pi maintenance commands remotely over SSH.
iints makerfaire up¶
Start the Pi booth flow.
iints makerfaire autostart¶
Prepare booth autostart files.
iints makerfaire watchdog¶
Recover the booth runtime if it stops.
Diagnostics¶
iints doctor¶
Basic and full environment checks.
iints doctor
iints doctor --full --suggest
iints doctor --smoke-run
Full Details¶
For every option and advanced workflow, continue to: - User Guide Map - CLI & Advanced Reference - Scientific Workflow - Study Analysis