diff --git a/README.md b/README.md index 0d5d27bd..aa3a1b1d 100644 --- a/README.md +++ b/README.md @@ -673,7 +673,7 @@ echo "leaf" > leaf-workspace/leaf.txt ```bash cat << EOF > leaf-dataset-config.yaml kind: DataSetConfiguration -apiVersion: client.uor-framework.io/v1alpha1 +apiVersion: client.emporous.io/v1alpha1 collection: components: cpes: @@ -695,8 +695,8 @@ EOF 4. Build and push the leaf collection to the remote registry ```bash -uor-client-go build collection leaf-workspace --plain-http localhost:5000/exercises/leaf:latest --dsconfig leaf-dataset-config.yaml -uor-client-go push --plain-http localhost:5000/exercises/leaf:latest +emporous build collection leaf-workspace --plain-http localhost:5000/exercises/leaf:latest --dsconfig leaf-dataset-config.yaml +emporous push --plain-http localhost:5000/exercises/leaf:latest ``` 5. Build a Root collection and link the previously built collection @@ -717,7 +717,7 @@ echo "root" > root-workspace/root.txt ```bash cat << EOF > root-dataset-config.yaml kind: DataSetConfiguration -apiVersion: client.uor-framework.io/v1alpha1 +apiVersion: client.emporous.io/v1alpha1 collection: linkedCollections: - localhost:5000/exercises/leaf:latest @@ -740,12 +740,12 @@ EOF 8. Build and push the root collection to the remote registry ```bash -uor-client-go build collection root-workspace --plain-http localhost:5000/exercises/root:latest --dsconfig root-dataset-config.yaml -uor-client-go push --plain-http localhost:5000/exercises/root:latest +emporous build collection root-workspace --plain-http localhost:5000/exercises/root:latest --dsconfig root-dataset-config.yaml +emporous push --plain-http localhost:5000/exercises/root:latest ``` 9. Create inventory ```bash -uor-client-go create inventory localhost:5000/exercises/root:latest --plain-http +emporous create inventory localhost:5000/exercises/root:latest --plain-http ``` > TIP: To avoid the requirement to manually input component information, test with a file that is already in a packaged format. This has been successfully tested with rpms. diff --git a/docs/usage/emporous.md b/docs/usage/emporous.md index 5f800a28..f8ea13a2 100644 --- a/docs/usage/emporous.md +++ b/docs/usage/emporous.md @@ -28,6 +28,7 @@ emporous [flags] ### SEE ALSO * [emporous build](emporous_build.md) - Build and save an OCI artifact from files +* [emporous create](emporous_create.md) - Create artifacts from existing OCI artifacts * [emporous inspect](emporous_inspect.md) - Print Emporous collection information * [emporous pull](emporous_pull.md) - Pull a Emporous collection based on content or attribute address * [emporous push](emporous_push.md) - Push a Emporous collection into a registry diff --git a/docs/usage/emporous_create.md b/docs/usage/emporous_create.md new file mode 100644 index 00000000..713c3c48 --- /dev/null +++ b/docs/usage/emporous_create.md @@ -0,0 +1,28 @@ +## emporous create + +Create artifacts from existing OCI artifacts + +``` +emporous create [flags] +``` + +### Options + +``` + -c, --configs stringArray Path(s) to your registry credentials. Defaults to well-known auth locations ~/.docker/config.json and $XDG_RUNTIME_DIR/container/auth.json, in respective order. + -h, --help help for create + --insecure Allow connections to registries SSL registry without certs + --plain-http Use plain http and not https when contacting registries +``` + +### Options inherited from parent commands + +``` + -l, --loglevel string Log level (debug, info, warn, error, fatal) (default "info") +``` + +### SEE ALSO + +* [emporous](emporous.md) - Emporous Client +* [emporous create inventory](emporous_create_inventory.md) - Create software inventories from UOR artifacts + diff --git a/docs/usage/emporous_create_inventory.md b/docs/usage/emporous_create_inventory.md new file mode 100644 index 00000000..0ea10ac3 --- /dev/null +++ b/docs/usage/emporous_create_inventory.md @@ -0,0 +1,35 @@ +## emporous create inventory + +Create software inventories from UOR artifacts + +``` +emporous create inventory SRC [flags] +``` + +### Examples + +``` + # Build inventory from artifacts. + emporous create inventory localhost:5000/myartifacts:latest +``` + +### Options + +``` + -f, --format string software inventory format. Options are cyclonedxjson or spdx22json. Default is spdx22json + -h, --help help for inventory +``` + +### Options inherited from parent commands + +``` + -c, --configs stringArray Path(s) to your registry credentials. Defaults to well-known auth locations ~/.docker/config.json and $XDG_RUNTIME_DIR/container/auth.json, in respective order. + --insecure Allow connections to registries SSL registry without certs + -l, --loglevel string Log level (debug, info, warn, error, fatal) (default "info") + --plain-http Use plain http and not https when contacting registries +``` + +### SEE ALSO + +* [emporous create](emporous_create.md) - Create artifacts from existing OCI artifacts +