update getting started

kosli-dev · Dec 18, 2024 · f1b8ca9 · f1b8ca9
1 parent db7dae7
commit f1b8ca9
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/docs.kosli.com/content/getting_started/artifacts.md b/docs.kosli.com/content/getting_started/artifacts.md
@@ -32,17 +32,25 @@ $ kosli attest artifact project-a-app.bin \
 	--artifact-type file \
 	--build-url https://exampleci.com \
 	--commit-url https://github.com/ProjectA/ProjectAApp/commit/e67f2f2b121f9325ebf166b7b3c707f73cb48b14 \
-	--git-commit e67f2f2b121f9325ebf166b7b3c707f73cb48b14 \
+	--commit e67f2f2b121f9325ebf166b7b3c707f73cb48b14 \
 	--flow project-a \
 	--trail trail-1 \
 	--name backend
 ```
+
+The `--artifact-type` flag is used to determine the type of artifact being attested. The following types are supported:
+
+- **file**: for any single file artifacts (e.g. a binary, Jar file, etc.)
+- **dir**: for directory artifacts.
+- **docker**: for docker images that are pulled on the machine. This option depends on having a running Docker daemon on the machine.
+- **oci**: for container images in docker or OCI format. The fingerprint is fetched directly from the registry.
+
 See [kosli attest artifact](/client_reference/kosli_attest_artifact/) for more details. 
 
 
 ## The --dry-run flag
 
-All Kosli CLI commands accept the `--dry-run` [boolean flag](/faq/#boolean-flags). 
+All Kosli CLI commands which write data accept the `--dry-run` [boolean flag](/faq/#boolean-flags). 
 When this flag is used, a CLI command:
 * Does not communicate with Kosli at all
 * Prints the payload it would have sent

diff --git a/docs.kosli.com/content/getting_started/install.md b/docs.kosli.com/content/getting_started/install.md
@@ -1,9 +1,9 @@
 ---
-title: "Part 2: Install Kosli"
+title: "Part 2: Install Kosli CLI"
 bookCollapseSection: false
 weight: 220
 ---
-# Part 2: Install Kosli
+# Part 2: Install Kosli CLI
 
 Kosli CLI can be installed from package managers, 
 by Curling pre-built binaries, or can be used from the distributed Docker images.
@@ -98,7 +98,7 @@ kosli version
 ```
 The expected output should be similar to this:
 ```plaintext {.light-console}
-version.BuildInfo{Version:"v{{< cli-version >}}", GitCommit:"4058e8932ec093c28f553177e41c906940114866", GitTreeState:"clean", GoVersion:"go1.19.5"}
+version.BuildInfo{Version:"2.11.4", GitCommit:"Homebrew", GitTreeState:"clean", GoVersion:"go1.23.4"}
 ```
 
 ## Using the CLI

diff --git a/docs.kosli.com/content/getting_started/overview.md b/docs.kosli.com/content/getting_started/overview.md
@@ -5,7 +5,7 @@ weight: 210
 ---
 # Part 1: Overview
 
-The "Getting Started" section encompasses the steps you can follow to implement Kosli in your organization. It focuses on general instructions for using Kosli and doesn't delve into specific tutorials for integrating Kosli with particular tools or runtime environments. For tailored tutorials catering to specific integrations, please refer to [tutorials](/tutorials).
+The "Getting Started" section contains the steps you can follow to implement Kosli in your organization. It focuses on general instructions for using Kosli and doesn't delve into specific tutorials for integrating Kosli with particular tools or runtime environments. For tailored tutorials catering to specific integrations, please refer to [tutorials](/tutorials).
 
 {{< hint success >}}
 If you're eager to start using Kosli right away, check our ["Get familiar with Kosli"](/tutorials/get_familiar_with_kosli/) tutorial that allows you to quickly try out Kosli features without the need to spin up a separate environment. No CI required.