Skip to main content

Module builtins

Module builtins 

Source
Expand description

Built-in fdl sub-commands (setup, install, completions, schema, config, libtorch, diagnose, init, skill, …). Registry of built-in commands. Single source of truth for dispatch, help listing, collision detection, and shell completion.

Each leaf sub-command owns a #[derive(FdlArgs)] struct that carries the canonical flag set. BuiltinSpec::schema_fn returns the Schema derived from that struct, so completion rules (--cuda <TAB>12.6 12.8, etc.) flow through the same pipeline as project commands rather than a hand-mirrored flag table.

Structs§

AddArgs
Add a flodl ecosystem crate to the current flodl project.
ApiRefArgs
Generate flodl API reference.
BuiltinSpec
One built-in command (or sub-command) slot.
DiagnoseArgs
System and GPU diagnostics.
InitArgs
Scaffold a new floDl project.
InstallArgs
Install or update fdl globally (~/.local/bin/fdl).
JoinArgs
Join a cluster run’s window as a self-deployed worker.
JoinConfigArgs
Provision a walk-in farm in one pass: the farm overlay (fdl.<label>.yml, token stamped), an ed25519 join key born in ./.fdl/<label>/ so it cannot be shared across farms by construction, the guardrailed authorized_keys line for the chosen door, the paste-ready worker yml, a publish recipe derived from the training crate’s own manifest, and a build-freshness report. A farm IS an env overlay: fdl @<label> <cmd> targets it afterwards. Regenerating credentials for a new farm instantiation is fdl join-config <label> --regen.
LibtorchActivateArgs
Activate a libtorch variant.
LibtorchBuildArgs
Build libtorch from source.
LibtorchDownloadArgs
Download a pre-built libtorch variant.
LibtorchListArgs
List installed libtorch variants.
LibtorchRemoveArgs
Remove a libtorch variant.
NcclBuildArgs
Build NCCL from NVIDIA source for a heterogeneous-arch rig.
ProbeArgs
Cluster readiness probe.
PublishArgs
Publish a training run for a fleet to pull.
SchemaClearArgs
Clear cached schemas. No command name clears all.
SchemaListArgs
List cached --fdl-schema outputs.
SchemaRefreshArgs
Re-probe each entry and rewrite the cache.
SetupArgs
Interactive guided setup wizard.
SkillInstallArgs
Install AI coding assistant skills.
StartArgs
Fire the operator start switch of a staging cluster run.
StatusArgs
Live cluster run status.

Functions§

is_builtin_name
True when name is a reserved top-level built-in (visible or hidden).
registry
Ordered registry of every built-in. Order drives fdl -h and the top-level completion word list, so it mirrors today’s BUILTINS const in main.rs.
visible_top_level
Visible top-level built-ins as (name, description) pairs, in registry order. Feeds run::print_project_help and the fallback print_usage.