make propolis-cli spec-driven

bin/propolis-cli/Cargo.toml

@@ -7,10 +7,12 @@ edition = "2021"
 [dependencies]
 anyhow.workspace = true
 clap = { workspace = true, features = ["derive"] }
+crucible-client-types.workspace = true
 futures.workspace = true
 libc.workspace = true
 newtype-uuid.workspace = true
 propolis-client.workspace = true
+propolis-config-toml.workspace = true
 slog.workspace = true
 slog-async.workspace = true
 slog-term.workspace = true

bin/propolis-cli/README.md

@@ -0,0 +1,41 @@
+# Propolis CLI
+
+The `propolis-cli` utility provides a user-friendly frontend to the
+[`propolis-server`](../propolis-server) REST API.
+
+## Getting started
+
+The easiest way to launch a VM via the CLI is to write a TOML file describing
+the VM's configuration. An example of such a file might be the following:
+
+```toml
+[block_dev.alpine_iso]
+type = "file"
+path = "/path/to/alpine-extended-3.12.0-x86_64.iso"
+
+[dev.block0]
+driver = "pci-virtio-block"
+block_dev = "alpine_iso"
+pci-path = "0.4.0"
+
+[dev.net0]
+driver = "pci-virtio-viona"
+vnic = "vnic_name"
+pci-path = "0.5.0"
+```
+
+To create and run a Propolis VM using this configuration:
+
+```
+# propolis-cli -s <server ip> -p <port> new --config-toml <path> <VM name>
+# propolis-cli -s <server ip> -p <port> state run
+```
+
+To connect to the VM's serial console:
+
+```
+# propolis-cli -s <server ip> -p <port> serial
+```
+
+Run `propolis-cli --help` to see the full list of supported commands and their
+arguments.