mirror of
https://github.com/vhaudiquet/ecrou.git
synced 2026-11-12 22:22:44 +00:00
docs(cli): plainen the command one-liners
The list view now says what each command does in the plainest verbs: run boots a command from an image, pull downloads one, probe checks the requirements. The long help keeps the contracts — freshness semantics, what probe actually tests.
This commit is contained in:
1 parent
0ad07c182f
commit
06856d532f
1 file changed
+4
-4
@@ -7,7 +7,7 @@ use clap::{Args, Parser, Subcommand};
|
|||||||
name = "ecrou",
|
name = "ecrou",
|
||||||
version,
|
version,
|
||||||
about = "Run commands in disposable microVMs on libkrun",
|
about = "Run commands in disposable microVMs on libkrun",
|
||||||
after_help = "Examples:\n ecrou run -it alpine a shell in the machine\n ecrou run ubuntu -- uname -a one command; its exit code propagates\n ecrou run -v $PWD:/src ubuntu -- make share the working tree into the machine\n ecrou pull alpine fetch or refresh the cache entry\n ecrou probe report what a run would find on this host"
|
after_help = "Examples:\n ecrou run -it alpine a shell in the machine\n ecrou run ubuntu -- uname -a one command\n ecrou run -v $PWD:/src ubuntu -- make share the working tree into the machine\n ecrou pull alpine fetch or refresh an image\n ecrou probe check for requirements"
|
||||||
)]
|
)]
|
||||||
pub struct Cli {
|
pub struct Cli {
|
||||||
#[command(subcommand)]
|
#[command(subcommand)]
|
||||||
@@ -19,7 +19,7 @@ pub struct Cli {
|
|||||||
|
|
||||||
#[derive(Subcommand, Debug)]
|
#[derive(Subcommand, Debug)]
|
||||||
pub enum Command {
|
pub enum Command {
|
||||||
/// Run a command in a fresh microVM
|
/// Run a command in a microVM from an image
|
||||||
///
|
///
|
||||||
/// IMAGE is a distro name (alpine, ubuntu:noble), an OCI image
|
/// IMAGE is a distro name (alpine, ubuntu:noble), an OCI image
|
||||||
/// reference (ghcr.io/org/image:tag, ubuntu@sha256:...), or a
|
/// reference (ghcr.io/org/image:tag, ubuntu@sha256:...), or a
|
||||||
@@ -29,7 +29,7 @@ pub enum Command {
|
|||||||
/// away. Persistence crosses a --volume share or it does not
|
/// away. Persistence crosses a --volume share or it does not
|
||||||
/// happen.
|
/// happen.
|
||||||
Run(RunArgs),
|
Run(RunArgs),
|
||||||
/// Fetch or refresh an image's cache entry without booting it
|
/// Download an image from a registry
|
||||||
///
|
///
|
||||||
/// Unpinned OCI tags are re-checked against the registry digest
|
/// Unpinned OCI tags are re-checked against the registry digest
|
||||||
/// and floating distro aliases (latest, lts, edge) re-resolved;
|
/// and floating distro aliases (latest, lts, edge) re-resolved;
|
||||||
@@ -43,7 +43,7 @@ pub enum Command {
|
|||||||
#[arg(long)]
|
#[arg(long)]
|
||||||
no_cache: bool,
|
no_cache: bool,
|
||||||
},
|
},
|
||||||
/// Report what a run would find on this host
|
/// Check for ecrou requirements
|
||||||
///
|
///
|
||||||
/// KVM working (device, API version, nested-virt state), the
|
/// KVM working (device, API version, nested-virt state), the
|
||||||
/// engine (libkrun.so.1) loadable, and the image cache usable.
|
/// engine (libkrun.so.1) loadable, and the image cache usable.
|
||||||
|
|||||||
Reference in new issue
Block a user