Skip to content

Commit c3bf2a5

Browse files
sammuliclaude
andcommitted
docs: describe device composition and capability scoping
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 89d2b73 commit c3bf2a5

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,28 @@ none is valid and the session is interactive; set `FDP_NO_AUTO_LOGIN=1` to
88
disable that (e.g. in batch jobs). `fdp logout` deletes the cached token.
99
`fdp env` never launches the flow. Resolution order: `-t/--bearer-token`,
1010
then `$BEARER_TOKEN`, then the managed cache, then the legacy `~/.fdp/token`.
11+
12+
## Devices
13+
14+
`fdp` discovers devices (tokamaks) from installed packages: `toksearch_d3d`
15+
contributes `d3d`, `toksearch_mast` contributes `mast`.
16+
17+
Most commands need no device selection:
18+
19+
- `fdp env` / `fdp run` compose the environments of **all** installed devices.
20+
Their variables are disjoint, so the union is well-defined. If two devices
21+
ever set the same variable to different values, `fdp` reports the conflicting
22+
variable and asks you to choose.
23+
- `fdp ls` uses the device that has an origin server.
24+
- `fdp login` / `fdp logout` use the device that requires a bearer token.
25+
26+
To choose explicitly, in increasing order of persistence:
27+
28+
```bash
29+
fdp --device d3d ls /archives # one invocation (also: fdp ls -D d3d)
30+
export FDP_DEFAULT_DEVICE=d3d # one shell
31+
fdp device use d3d # recorded in ~/.fdp/config.toml
32+
fdp device use --clear # undo
33+
```
34+
35+
`fdp device list` shows each installed device and its capabilities.

0 commit comments

Comments
 (0)