fix: correct CLI docs against kbc --help source of truth (PRDCT-370) - #397
Open
Iamfle4ka wants to merge 2 commits into
Open
fix: correct CLI docs against kbc --help source of truth (PRDCT-370)#397Iamfle4ka wants to merge 2 commits into
Iamfle4ka wants to merge 2 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>
Contributor
🤖 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:
|
Iamfle4ka
marked this pull request as ready for review
July 10, 2026 13:53
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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