Description
The kci
command is to the new API & Pipeline what the kci_*
tools were for the legacy system. It needs to be clearly designed to ease adoption by the community as a tool for KernelCI core developers but also any member of the kernel ecosystem: kernel developers, test system developers etc. I should help with prototyping features by hand before automating them with services running event loops and also work hand-in-hand with the new web dashboard.
Several aspects need to be considered, in particular: feature set, ease of implementation and maintenance of the code, direct user experience, documentation, accessibility.
Here are some of the topics as part of the preparation work:
- `kci` rework: Click or Typer? kernelci-project#258
- `kci` command line syntax kernelci-project#263
- TOML settings and `kci` tool kernelci-project#261
Based on the outcome of these, here's the list of tasks to complete:
- Legacy code moved to
kernelci.legacy
- New
kci
entry point command implemented using chosen framework - TOML settings features integrated with arguments parsing and secrets
- Common options and CLI framework
- Required set of sub-commands implemented
-
kci user
- Rework
kci user
with new framework #2141 - Add
kci user
commands (was #2157) #2183 - Add
kci
commands for managing user groups #2084 - Accept either username or email in
kci user
commands #2205 - kernelci.cli.user: send API token to GET user matching ID #2239
- kernelci.cli.user: send token to GET users requests #2236
- Rework
-
kci config
-
kci job
-
kci node
-
kci event
-
kci storage
- Rework
kci docker
with new framework #2134
-
- Documentation updated accordingly
- HTML / Markdown for online pages
- man pages and offline help
Some follow-up GitHub issues will be created for additional commands such as kci view
, kci bisect
, kci email
etc.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Todo