Reference

CLI reference

dex [--version] [--install-completion] [--show-completion] COMMAND [ARGS]...

“Needs a checkout” means the command must run inside a Dex-Trove repository (a directory with sources.yaml and src/dex_trove/). Read-only commands work from the installed wheel.

REF arguments accept namespace/name, a unique bare name, or kind:namespace/name.

dex sources

dex sources [--json]

Prints the sources in sources.yaml (id, adapter, repo or local path, enabled, first-party) and the evaluated candidates. --json dumps both lists.

dex learn

dex learn [SOURCE_IDS]... [--dry-run] [--prefer-local] [--no-refresh]

Fetches each source and runs the learn pipeline. With no arguments, all enabled sources are learned; named sources are learned even if disabled.

Per source it prints <id> @ <commit>: N admitted, M excluded {reason: count}, K removed. It then rewrites trove/catalog.json, trove/EXCLUDED.json, trove/trove.lock.json and THIRD_PARTY_NOTICES.md. A source that fails to fetch is reported (skip <id>: …) and its existing items are left untouched.

Exit codes: 0 success, 2 unknown source id or not in a checkout.

dex validate

dex validate

Checks the trove in use (the checkout’s trove/, or the installed package):

• catalog.json lists exactly the items on disk
• every item name is valid and its licence verdict is allow
• every listed file exists, and the recomputed content hash matches content_hash (no drift)
• ananke.yaml exists and agrees with dex.json (kind, version)
• if ananke-plexus is importable, every manifest validates against Ananke’s strict ArtifactManifest model
• in a checkout, THIRD_PARTY_NOTICES.md is current

Prints ✓ N items valid, or one ✗ line per problem and exits 1.

dex list

dex list [--kind/-k KIND] [--source/-s NAMESPACE] [--json]

Lists items as a table (kind, id, licence, description) or JSON (kind, id, version, title).

dex search

dex search QUERY... [--kind/-k KIND] [--source/-s NAMESPACE] [--limit/-n 25] [--json]

Every word must match the name, title, tags or description. Results are ranked with weights name 5, title 3, tags 2, description 1.

dex show

dex show REF [--json]

Title, kind, id and version, description, source with pinned upstream URL, licence with evidence, inspirations, plugin members, files and the local path. --json prints the full dex.json. Exit 2 if the ref is unknown or ambiguous.

dex install

dex install REF... [--target/-t claude|copilot|dir] [--scope user|project] [--path DIR] [--allow-exec]

Prints ✓ kind:id → destination for each installed item, and – kind:id: reason for skipped ones (an unsupported kind for the target, or a hook without --allow-exec). Plugins expand to their members. See Installing items. Exit 2 on an unknown ref or target.

dex license

dex license PATH

Classifies a licence file, or every licence file directly in a directory: PATH: SPDX → verdict (evidence). Exit 1 if no licence files are found.

dex notices

dex notices

Regenerates THIRD_PARTY_NOTICES.md from the trove. dex learn does this automatically.

dex catalog

dex catalog

Rebuilds catalog.json from the dex.json files on disk and refreshes EXCLUDED.json and the lock without learning. Use it after resolving a merge conflict in trove/.

dex ananke sync

dex ananke sync [--project DIR] [--kind/-k KIND]... [--source/-s NS]... [--name/-n NAME]...
                [--dry-run] [--include-flagged] [--ananke-bin PATH]

Runs ananke registry learn over the selected items. Filters are repeatable and combined with AND across option types. --name accepts name or ns/name.

Prints Ananke’s output, then ✓ N trove items offered to Ananke. Exit 2 if ananke isn’t found or nothing matches; otherwise Ananke’s exit code.

dex docs export

dex docs export [--out website/src]

Writes content/items/*.md and data/search.json + data/trove.json under --out. See Docs site.

Exit codes

Edit this page on GitHub ↗