kosli snapshot path

Synopsis

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 , 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 file is always treated as part of the artifact: its own entries cannot exclude it, so the exclusion list cannot be changed without changing the fingerprint. Paths the list already matches stay excluded whatever is later added there, so keep its entries as narrow as possible. Excluding the file with --exclude keeps it out of the fingerprint but still applies the paths it lists, which lets a writable directory change the list again. To drop the file from the fingerprint safely, move its entries to --exclude and delete it.

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. Config is read from this path or the default only, never implicitly from the current directory. (default “$HOME/.kosli.yml”)
`--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”)
`--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.

report one artifact running in a specific path in a filesystem

kosli snapshot path yourEnvironmentName 
	--path path/to/your/artifact/dir/or/file 
	--name yourArtifactDisplayName 

report one artifact running in a specific path in a filesystem AND exclude certain path patterns

kosli snapshot path yourEnvironmentName 
	--path path/to/your/artifact/dir 
	--name yourArtifactDisplayName 
	--exclude **/log,unwanted.txt,path/**/output.txt

General

Top-level commands

kosli allow

kosli archive

kosli assert

kosli attest

kosli begin

kosli create

kosli delete

kosli diff

kosli disable / enable

kosli evaluate

kosli get

kosli join

kosli list

kosli log

kosli rename

kosli report

kosli rotate

kosli snapshot

kosli unarchive

kosli update

Synopsis

Flags

Flags inherited from parent commands

Examples Use Cases

​Synopsis

​Flags

​Flags inherited from parent commands

​Examples Use Cases

Synopsis

Flags

Flags inherited from parent commands

Examples Use Cases