docs: document that config files are no longer loaded from the working directory - #416
Conversation
The CLI loaded a kosli.<yaml|yml|toml|json|env> file from the directory it ran in, without --config-file. That let the contents of a repository set host, http-proxy or kubeconfig for a command run with a real API token, so it is gone from v2.40.0. Both places that documented the implicit default now describe the $HOME/.kosli.yml default and carry a warning naming the migration, and the generated reference pages pick up the new --config-file default. Refs kosli-dev/server#6778, kosli-dev/server#6779 Refs kosli-dev/cli#1152 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @pbeckham's task in 2m 29s —— View job Doc review — PR #416
Both findings from the previous review are fixed at
Extracting the warning to Nothing here blocks the merge. Three things worth a look, in order: 1. Verify extension inference survived v2.40.0 — the example sits two lines above the new textBoth edited pages tell readers they can drop the extension, on lines the PR leaves untouched:
2. The changelog entry announcing the break has no migration path
Two gaps against the snippet this PR just wrote. It names only 3. The API-token page omits the default config file
|
The warning named kosli.<yaml|toml|json|env>, omitting yml. That is the extension the migration advice itself uses, so a reader holding kosli.yml scanned the list, did not find their file, and concluded the change did not apply to them. The old implicit search covered every extension viper supports, so no short list is complete; this one now names the formats the surrounding pages document and drops env, which appeared nowhere else. The advice also told readers to pass --config-file kosli.yml. Elsewhere on the site kosli.yml is a flow template passed with --template-file, so that wording invited pointing the config loader at a template. It now refers to the reader's own file, as the CLI's own warning does. Both pages carried the four sentences verbatim, which is what snippets/ exists for, and the two corrections above would otherwise have had to be made twice. Adds two facts established from the CLI source: the settings can be moved to the home config with kosli config, and --quiet suppresses the warning. Refs kosli-dev/server#6778 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Triage of the four findings. 1, 2 and 4 are fixed in ad9cbc2; 3 is not a problem, with evidence below. 1. Missing 2. 3. Does 4. Duplicated verbatim across two pages — fixed. Extracted to On the warning you could not verify from this repo: it is real. |
Follow-up to kosli-dev/server#6778, documenting the CLI change made in kosli-dev/cli#1152.
Corrects the two pages that told readers a
kosli.ymlin their working directory would be picked up automatically. Both now describe the$HOME/.kosli.ymldefault and carry a warning naming the migration.Why
Until v2.39.2 the CLI loaded
kosli.<yaml|yml|toml|json|env>from the directory it ran in, with no--config-file. A repository could therefore sethostfor any command run against it with a real API token, sendingAuthorization: Bearer <token>to an attacker-chosen host. That is fixed in v2.40.0, but the docs still described the old behaviour, so a reader following them writes a config file the CLI now ignores and gets no explanation for why their settings stopped applying.What changed
faq/faq.mdandgetting_started/install.md. Each replaces the implicit-default claim with the$HOME/.kosli.ymldefault and how to name any other file, then adds a Warning covering what changed, why, and the migration: pass--config-file kosli.ymlor setKOSLI_CONFIG_FILE. No navigation or structural change.The generated
client_reference/pages already carry the new--config-filehelp text, from the v2.40.1 reference regeneration on main.Verification
Doc Review and PR Quality Checks gate this PR, and both changed files are Markdown so the doc-quality review runs on them. The version claims hold against the CLI releases: v2.39.2 (2026-09-01) is the last release with the old behaviour, v2.40.0 (2026-09-11) the first without it.
🤖 Generated with Claude Code