> ## Documentation Index
> Fetch the complete documentation index at: https://kosli-docs-agentcore-how-to-355.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# kosli snapshot path

> Report a snapshot of a single artifact running in a specific filesystem path to Kosli.  

## Synopsis

```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
kosli snapshot path ENVIRONMENT-NAME [flags]
```

Report a snapshot of a single artifact running in a specific filesystem path to Kosli.\
You can report a directory or file artifact. For reporting multiple artifacts in one go, use "kosli snapshot paths".
You can exclude certain paths or patterns from the artifact fingerprint using `--exclude`.
The supported glob pattern syntax is documented here: [https://pkg.go.dev/path/filepath#Match](https://pkg.go.dev/path/filepath#Match) ,
plus the ability to use recursive globs "\*\*"

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

## Flags

| Flag              | Type    | Description                                                                                                                          |
| :---------------- | :------ | :----------------------------------------------------------------------------------------------------------------------------------- |
| `-D`, `--dry-run` | bool    | \[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. |
| `-x`, `--exclude` | strings | \[optional] The comma-separated list of literal paths or glob patterns to exclude when fingerprinting the artifact.                  |
| `-h`, `--help`    | bool    | help for path                                                                                                                        |
| `--name`          | string  | The reported name of the artifact.                                                                                                   |
| `--path`          | string  | The base path for the artifact to snapshot.                                                                                          |
| `--watch`         | bool    | \[optional] Watch the filesystem for changes and report snapshots of artifacts running in specific filesystem paths to Kosli.        |

## Flags inherited from parent commands

| Flag                        | Type   | Description                                                                                                                                                                                                                                              |
| :-------------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-a`, `--api-token`         | string | The Kosli API token.                                                                                                                                                                                                                                     |
| `-A`, `--auto-environment`  | bool   | \[optional] Create the environment (with the type inferred from the snapshot subcommand) if it does not already exist, before reporting the snapshot.                                                                                                    |
| `-c`, `--config-file`       | string | \[optional] The Kosli config file path. (default "kosli")                                                                                                                                                                                                |
| `--debug`                   | bool   | \[optional] Print debug logs to stdout.                                                                                                                                                                                                                  |
| `--environment-description` | string | \[optional] The environment description.                                                                                                                                                                                                                 |
| `--exclude-scaling`         | bool   | \[optional] Exclude scaling events for snapshots. Snapshots with scaling changes will not result in new environment records. (DEPRECATED: this flag is deprecated and will be removed in a future version. Scaling events do not trigger new snapshots.) |
| `-H`, `--host`              | string | \[defaulted] The Kosli endpoint. (default "[https://app.kosli.com](https://app.kosli.com)")                                                                                                                                                              |
| `--http-proxy`              | string | \[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`                                                                                                                                              |
| `--include-scaling`         | bool   | \[optional] Include scaling events for snapshots. Snapshots with scaling changes will result in new environment records. (DEPRECATED: this flag is deprecated and will be removed in a future version. Scaling events do not trigger new snapshots.)     |
| `-r`, `--max-api-retries`   | int    | \[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)                                                                                                                                                  |
| `--org`                     | string | The Kosli organization.                                                                                                                                                                                                                                  |
| `-q`, `--quiet`             | bool   | \[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.                                                                                                  |

## Examples Use Cases

These examples all assume that the flags  `--api-token`, `--org`, `--host`, (and `--flow`, `--trail` when required), are [set/provided](/getting_started/install/#assigning-flags-via-environment-variables).

<AccordionGroup>
  <Accordion title="report one artifact running in a specific path in a filesystem">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli snapshot path yourEnvironmentName 
    	--path path/to/your/artifact/dir/or/file 
    	--name yourArtifactDisplayName 

    ```
  </Accordion>

  <Accordion title="report one artifact running in a specific path in a filesystem AND exclude certain path patterns">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli snapshot path yourEnvironmentName 
    	--path path/to/your/artifact/dir 
    	--name yourArtifactDisplayName 
    	--exclude **/log,unwanted.txt,path/**/output.txt
    ```
  </Accordion>
</AccordionGroup>