Store
The commands that find, add and publish packages of the Arche Store.
Commands: archec store · archec add · archec audit · archec publish · archec search · archec shelf
The Arche Store: architectures, drivers, specifications and boards people share, as signed packages. Which store: --store <where> (a folder, a git URL, or a hosted store's https URL), else ARCHE_STORE, else what archec store use set. See the Arche Store.
| Command | What it does |
|---|---|
archec add <main.arche> <owner/name[@range]> [--dry-run] |
Takes a package and what it uses: the newest version in the range this archec reads (or the one arche.lock names), checked against the store (archive hash, the publisher's signature, the files' fingerprint) and the project's trust, unpacked into .arche/store/<name>@<version>/. Writes uses <name> "^x.y", updates arche.lock, and lists the code it brought. Nothing is written when one check fails. A store on another machine is reached only when allowed: archec config allow store https://store.arche-lang.xyz (ai-engineering.md). |
archec audit <main.arche> [--json] |
Every piece of code the project holds (code files and code blocks), grouped by where it came from: the project, a library of its own, or a store package with its version, fingerprint and trust. --authors: who wrote it instead (see provenance). |
archec publish <folder> |
The same as archec store publish. |
archec search <words> |
The same as archec store search. |
archec shelf [<shelf> [<piece>]] [--json] |
The store's six shelves of ready-made pieces: types, units, boards, drivers, sensors (and actuators), algorithms. With a shelf, its pieces one line each, grouped; with a piece (archec shelf units mAh, archec shelf types ImuSample), its card: the same seven lines for every piece — Does, Gives, Plugs into, Add it, Runs on, Tested, From. --json for each. See shelves. |
archec shelf add <main.arche> <piece> [--shelf <shelf>] [--dry-run] |
Adds a piece: the uses and the include of its library, written only if the project still builds; a board or a device as archec board add and archec device add do. A unit is built in: nothing to add. |
archec store fetch <main.arche> |
The store packages arche.lock names that are not in .arche/store (a fresh checkout), in the locked version, checked against the lock's fingerprint. |
archec store outdated <main.arche> [--json] |
Each installed package against its store: a newer version this archec reads, or a yank (recorded, so archec check warns about it). Exit 1 on a yank. |
archec store search <words> [--kind <kind>] [--json] / archec store info <owner/name> |
Find packages by name, keywords and description; one package's versions, license, export classification, badges and family. |
archec store diff <owner/name> <version> <version> [--json] |
What the model gained, lost or changed between two versions: systems, components, their parts, ports and links, interfaces, messages and requirements, compared as declarations, not as text. |
archec store check <folder> |
What publishing would refuse (no owner, license or export-control; a script, a binary, an executable file; a syntax error), warn about, or hold for a reviewer (words that read like defence technology). |
archec store card <folder> [-o card.html] |
The package's page as the store shows it: its README and what archec reads from the model (systems, components, boards, interfaces, requirements, the code it brings). |
archec store pack <folder> [-o <dir>] |
The .archepkg file: the same folder always packs to the same bytes. |
archec store publish <folder> [--dry-run] [--private] |
Checked, packed, signed with the owner's key (made the first time, in ~/.arche/keys) and written into the store: a folder or a git clone (then commit and open a pull request), or uploaded to a hosted store. A published version never changes. --private: only the owner's organisation sees it (hosted store). |
archec store package <dir> --from capella <model.capella|.aird|folder|.zip> / --from polarion <polarion.yaml|workitems.json> --owner <o> --license <SPDX> --export-control <none|…> [--name n] [--version 0.1.0] [--kind k] [--label "…"] [--description "…"] [--keywords a,b] |
An import as a package, in one step: the importer writes the model into <dir> (archec capella; Polarion's work items as requirements.arche), then library.arche and a README, and the package is checked as publish --dry-run checks it. Refused without an owner, a license or an export classification. Nothing is published. See the Arche Store. |
archec store yank <owner/name@version> --reason "…" |
The version is not taken any more, except by a lock that names it; projects that have it are told by archec store outdated. |
archec store init <folder> [--name "…"] |
A new index, laid out as a git repository with its GitHub workflow (checks pull requests, writes badges, publishes the pages). |
archec store seed <index> [--license <SPDX>] |
The packages archec ships: the board store and each board, the standard library, and the examples as architectures, published by arche (verified). |
archec store verify-index <index> [owner/name…] |
Every archive is the one its entry names, with the fingerprint and signature it records. |
archec store test <index> [owner/name…] [--all] [--write] [--breaks] |
Every package (its newest version, or --all) built with this archec as a project using it would build it, plus cppcheck and a Python parse of its code. --write records the badges; --breaks fails only on a package that passed with an earlier archec: run it before a release. |
archec store deps [<index>] [--json] |
Every package's newest version: each library it uses must be a store package with a version in range that is not yanked. Lists those that are not in the store, have no version in range, or only yanked ones; fails when there is one. |
archec store site <index> -o <dir> |
The store's pages: a searchable list, a page per package (card, versions, badges, family tree), publishers, collections, requests. Static: GitHub Pages serves them. |
archec store serve <index> [--port 8080] [--host 127.0.0.1] |
The hosted store: the pages and an API (search, packages, archives, publish, yank, review, stars, discussions, requests, downloads). Accounts are tokens; with GITHUB_CLIENT_ID/GITHUB_CLIENT_SECRET set, /auth/github signs people in with GitHub. |
archec store token <index> <user> [--org a,b] [--reviewer] [--admin] |
An account's token (shown once; only its hash is kept in <index>/.tokens.json). |
archec store login <url> --token <token> / archec store use <where> |
Sign in to a hosted store; set the store used by default. |
archec store review <owner/name@version> [--refuse --reason "…"] |
Releases a package held for review (a reviewer's account on a hosted store), or refuses it. |
archec store verify-publisher <index> <owner> [--name "…"] |
Marks a publisher verified (a board vendor, a known project): their packages are verified, the only ones trust verified accepts. |
archec store collection <index> <id> "Title" <owner/name>… |
A hand-picked list of packages, shown on the Collections page. |
archec store request "…" [--kind board] / archec store star / archec store discuss |
Ask for a board or driver that is missing; star a package; post on its page (stars and discussions: hosted store). |
archec store import-zephyr <zephyr>/boards -o <folder> |
A board collection from Zephyr's board files: each board's processor (hal/chip for STM32, nRF, RP2040, ESP32), RAM, and its UART, CAN, SPI and I2C ports with their pins, as the DTS sets them. |