fix: correct CLI docs against kbc --help source of truth (PRDCT-370) - #397
fix: correct CLI docs against kbc --help source of truth (PRDCT-370)#397Iamfle4ka wants to merge 3 commits into
Conversation
- Fix --ci-pull frequency: 'every 5 minutes' → 'each hour' (sync init, ci workflows) - Fix --timeout defaults: '2m' → '5m' (job run, table unload) - Fix persist alias: 'kbc p' → 'kbc pt, persist' - Fix dbt generate env: wrong description and usage (was copy-pasted from sources) - Fix create row example: 'kbc create config' → 'kbc create row' - Fix workspace link: pointed to /remote/create/ instead of /remote/workspace/ - Fix 'brabch' typo in Next Steps links → 'branch' - Fix file upload example: '--name/--tags' → '--file-name/--file-tags' - Add missing --without-decompress flag (file download) - Add missing --cleanup flag (fix-paths) - Add missing --timeout flag (table download) Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
Verdict: needs_human (risk 2/5) · profile docs
Needs human: CLI flag defaults/aliases/frequencies are product-behaviour claims the bot can't verify, and one new option has a copy-paste defect.
Concerns:
cli/commands/remote/table/download/index.md: New --timeout says "unload job" (copy-paste) and keeps 2m vs unload's 5mcli/commands/remote/job/run/index.md: --timeout default 2m→5m is an unverifiable product-behaviour claimcli/commands/local/persist/index.md: Diff addskbc persistalias not mentioned in PR body; unverifiable
Suggested reviewers: @keboola/docs
Brings the branch up to date with main. No conflicts — this PR only touches /cli/ pages, which none of the retirements moved. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wc7aH2VDs4qYwxCai1JuSA
The first pass took the pages from developers-docs main, which still carries errors that an open PR there already fixes — keboola/developers-docs#397, "correct CLI docs against kbc --help", 14 files, mergeable since 2026-08-26. Porting from main would have moved known-wrong content into its new home and made that PR moot, since its target is about to be deleted. Re-generated from keboola#397's head instead. That supersedes the four corrections I had made by hand and brings six more I had missed: - remote table unload --timeout default 5m (I had only fixed remote job run) - remote table download --timeout default 5m - dbt generate env described and demonstrated "generate sources" — copy-paste error in the source - local create row example ran kbc create config - local fix-paths was missing --cleanup - remote file download was missing --without-decompress - remote file upload example used --name/--tags; the flags are --file-name/--file-tags - two "remote workspace" links pointed at /commands/remote/create/ 370 relative links, none broken.
|
Closing as moot — the pages this PR fixes are being deleted.
So the corrections here have no page left to land on. For the record, this PR was right about all of it, verified independently against
None of that survives the deletion. Recorded here so the next person auditing this CLI does not re-derive it. |
Jira issue(s): PRDCT-370
Changes:
Fixes PRDCT-370 — unambiguous code-accuracy divergences found by auditing all 57
/cli/pages againstkbc --helpbuilt fromkeboola/keboola-as-codeHEAD.Inaccurate values corrected:
--ci-pullfrequency: docs said "every 5 minutes" → CLI + workflow template cron (0 * * * *) say "each hour" (sync init, ci workflows pages)--timeoutdefault onremote job runandremote table unload: docs said2m→ CLI says5mlocal persistalias: docs saidkbc p→ CLI alias iskbc pt(alias table in commands/index.md was already correct)dbt generate envpage: description said "Generates sources" and usage showedkbc dbt generate sources→ copy-paste error, fixed toenvlocal create rowexample usedkbc create config→ fixed tokbc create rowremote file uploadexample used--name/--tags→ fixed to--file-name/--file-tagsBroken links fixed:
kbc remote workspacerow in commands/index.md and remote/index.md linked to/remote/create/→/remote/workspace/brabch→branchMissing flags added:
--without-decompressonremote file download--cleanuponlocal fix-paths--timeoutonremote table downloadAll changes match
kbc --helpoutput verbatim. No needs_human items are included.Full audit log (Block 0/A/B/C + summary) posted as a comment on PRDCT-370.
Release Notes
Justification, description
Documentation accuracy fixes — correcting flag defaults, aliases, broken links, and missing flags that diverged from the CLI source of truth.
Plans for Customer Communication
N/A
Impact Analysis
N/A — docs-only changes, no code or API impact.
Deployment Plan
Standard docs deployment via merge to main.
Rollback Plan
Revert PR.
Post-Release Support Plan
N/A
Link to Devin session: https://app.devin.ai/sessions/2dceb9b7d73f47f890612ddba70f681d
Requested by: @Iamfle4ka