Skip to content

Commit fb0be84

Browse files
committed
Document native admin CLI
1 parent 221df52 commit fb0be84

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

admin/bin/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# JWSTF Administration CLI
2+
3+
The `admin/bin` directory contains native C and C++ command-line front ends for the local JWSTF administration layer.
4+
5+
## Programs
6+
7+
- `jwstf-admin-c` — C implementation.
8+
- `jwstf-admin-cpp` — C++17 implementation.
9+
10+
## Build
11+
12+
```bash
13+
cd admin/bin
14+
make
15+
```
16+
17+
The source files are intentionally kept beside the native build definitions. Compiled binaries are local build artifacts and are not required to be committed to Git.
18+
19+
## Commands
20+
21+
```text
22+
status
23+
services
24+
modules
25+
software
26+
verify
27+
doctor
28+
install <component>
29+
repair <component>
30+
update <component>
31+
remove <component>
32+
```
33+
34+
Useful options:
35+
36+
```text
37+
--json
38+
--dry-run
39+
--help
40+
--version
41+
```
42+
43+
The current command layer is deliberately review-first. Installation, repair, update, and removal requests **do not execute privileged shell commands**. They report an operation request and establish the contract for a future authorization/execution backend.
44+
45+
This keeps the native CLI aligned with the JavaFX administration console: both are local interfaces over the same intended administration model, rather than unrestricted privileged shells.

0 commit comments

Comments
 (0)