marcoallegretti/karapace
1
0
Fork 0
mirror of https://github.com/marcoallegretti/karapace.git synced 2026-03-26 21:43:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document new and tui commands

Browse source 
Update README and CLI reference to include 'karapace new' and 'karapace tui'.

Note that 'tui' rejects --json output.
This commit is contained in:
Marco Allegretti 2026-02-23 12:16:12 +01:00
parent 8e90f45efc
commit 78f6d4e65e
2 changed files with 33 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -64,9 +64,10 @@ See `examples/` for more manifests: `minimal.toml`, `dev.toml`, `gui-dev.toml`,
## Commands ## Commands
23 commands. All accept `--json`, `--store <path>`, `--verbose`, `--trace`. 25 commands. All accept `--store <path>`, `--verbose`, `--trace`. All except `tui` accept `--json`.
``` ```
new <name> [--template] [--force] Generate `karapace.toml`
build [manifest] [--name] Build environment build [manifest] [--name] Build environment
rebuild [manifest] [--name] Destroy + rebuild rebuild [manifest] [--name] Destroy + rebuild
enter <id> [-- cmd...] Enter environment enter <id> [-- cmd...] Enter environment
@ -90,6 +91,7 @@ doctor Check prerequisites
migrate Check store version migrate Check store version
completions <shell> Shell completions completions <shell> Shell completions
man-pages [dir] Generate man pages man-pages [dir] Generate man pages
tui Terminal UI
``` ```
## Workspace ## Workspace
@ -101,7 +103,7 @@ karapace-schema Manifest, normalization, lock file, identity
karapace-store Objects, layers, metadata, WAL, GC, integrity karapace-store Objects, layers, metadata, WAL, GC, integrity
karapace-runtime Backends (namespace/oci/mock), images, security karapace-runtime Backends (namespace/oci/mock), images, security
karapace-core Engine: lifecycle orchestration karapace-core Engine: lifecycle orchestration
karapace-cli CLI (23 commands) karapace-cli CLI (25 commands)
karapace-dbus D-Bus service (optional) karapace-dbus D-Bus service (optional)
karapace-tui Terminal UI (optional) karapace-tui Terminal UI (optional)
karapace-remote Remote store client, push/pull karapace-remote Remote store client, push/pull

29
docs/cli-reference.md
View file

@ -34,6 +34,25 @@ Defined in `crates/karapace-cli/src/commands/mod.rs`.
## Commands ## Commands
### `new`
Generate a new `karapace.toml` manifest in the current directory.
```
karapace new <name> [--template <template>] [--force]
```
| Argument | Description |
|----------|-------------|
| `name` | Human-readable name used in interactive prompts and output |
| Flag | Description |
|------|-------------|
| `--template` | One of: `minimal`, `dev`, `gui-dev`, `rust-dev`, `ubuntu-dev` |
| `--force` | Overwrite `./karapace.toml` if it already exists |
If `--template` is not provided, the command uses interactive prompts (requires a TTY). If `./karapace.toml` exists and `--force` is not set, the command prompts on a TTY; otherwise it fails.
### `build` ### `build`
Build an environment from a manifest. Build an environment from a manifest.
@ -284,3 +303,13 @@ Check store format version and show migration guidance.
``` ```
karapace migrate karapace migrate
``` ```
### `tui`
Start the terminal UI.
```
karapace tui
```
This command is interactive and rejects `--json`.