Skip to content

docs: document that config files are no longer loaded from the working directory #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pbeckham merged 2 commits into from
Sep 15, 2026
+13 −2
Merged

docs: document that config files are no longer loaded from the working directory #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
899bf6e
docs: config files are no longer loaded from the current directory
pbeckham Sep 9, 2026
ad9cbc2
docs: correct the extension list and share the config warning
pbeckham Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion faq/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: FAQ
description: "Frequently asked questions"
---

import WorkingDirConfigNotice from "/snippets/cli-working-dir-config-notice.mdx";

<AccordionGroup>

<Accordion title="Where can I find API documentation?">
Expand Down Expand Up @@ -53,7 +55,9 @@ When calling a Kosli command you can skip the file extension. For example, to li
kosli list environments --config-file kosli-conf
```

`--config-file` defaults to `kosli`, so if you name your file `kosli.<yaml|toml|json>` and the file is in the same location as where you run Kosli commands from, you can skip the `--config-file` altogether.
`--config-file` defaults to `$HOME/.kosli.yml`, which is the file [`kosli config`](/client_reference/kosli_config) writes. Any other config file has to be named explicitly, either with `--config-file` on each command or by setting `KOSLI_CONFIG_FILE` in the environment.

<WorkingDirConfigNotice />
</Accordion>

<Accordion title="Reporting the same artifact and evidence multiple times">
Expand Down
6 changes: 5 additions & 1 deletion getting_started/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ description: "Instructions to install Kosli CLI on various platforms"
icon: "download"
---

import WorkingDirConfigNotice from "/snippets/cli-working-dir-config-notice.mdx";

<Steps>
<Step title="Choose your installation method">

Expand Down Expand Up @@ -165,7 +167,9 @@ Each key in the config file corresponds to the flag name, capitalized. For insta

Config files can be written in JSON, YAML, or TOML formats.

To direct Kosli CLI to use a config file, employ the --config-file flag when executing Kosli commands. By default, the CLI looks for a config file called `kosli.<yaml/yml/json/toml>`
To direct Kosli CLI to use a config file, employ the `--config-file` flag when executing Kosli commands, or set `KOSLI_CONFIG_FILE` in the environment. By default the CLI reads `$HOME/.kosli.yml`, the file [`kosli config`](/client_reference/kosli_config) writes; a config file anywhere else has to be named.

<WorkingDirConfigNotice />

Below are examples of different config file formats:

Expand Down
3 changes: 3 additions & 0 deletions snippets/cli-working-dir-config-notice.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<Warning>
Up to CLI v2.39.2, a file named `kosli.<yaml|yml|json|toml>` in the directory you ran Kosli from was loaded automatically, without `--config-file`. That is no longer the case, because it let the contents of a repository decide where the CLI sent your API token. If you relied on it, name your config file explicitly with `--config-file` on each command, or set `KOSLI_CONFIG_FILE` to its path. To apply its settings to every command instead, move them to your home config file with [`kosli config`](/client_reference/kosli_config). From v2.40.0 the CLI warns when it finds such a file and is ignoring it, unless you pass `--quiet`.
</Warning>