Skip to content

fix: correct CLI docs against kbc --help source of truth (PRDCT-370) - #397

Closed
Iamfle4ka wants to merge 3 commits into
mainfrom
devin/1782145879-PRDCT-370-cli-audit-fixes
Closed

fix: correct CLI docs against kbc --help source of truth (PRDCT-370)#397
Iamfle4ka wants to merge 3 commits into
mainfrom
devin/1782145879-PRDCT-370-cli-audit-fixes

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Jira issue(s): PRDCT-370

Changes:

Fixes PRDCT-370 — unambiguous code-accuracy divergences found by auditing all 57 /cli/ pages against kbc --help built from keboola/keboola-as-code HEAD.

Inaccurate values corrected:

  • --ci-pull frequency: docs said "every 5 minutes" → CLI + workflow template cron (0 * * * *) say "each hour" (sync init, ci workflows pages)
  • --timeout default on remote job run and remote table unload: docs said 2m → CLI says 5m
  • local persist alias: docs said kbc p → CLI alias is kbc pt (alias table in commands/index.md was already correct)
  • dbt generate env page: description said "Generates sources" and usage showed kbc dbt generate sources → copy-paste error, fixed to env
  • local create row example used kbc create config → fixed to kbc create row
  • remote file upload example used --name/--tags → fixed to --file-name/--file-tags

Broken links fixed:

  • kbc remote workspace row in commands/index.md and remote/index.md linked to /remote/create//remote/workspace/
  • "Create Branch" Next Steps link in local/create/config and local/create/row had typo brabchbranch

Missing flags added:

  • --without-decompress on remote file download
  • --cleanup on local fix-paths
  • --timeout on remote table download

All changes match kbc --help output 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

- 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>
@Iamfle4ka Iamfle4ka self-assigned this Jun 22, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@linear

linear Bot commented Jun 22, 2026

Copy link
Copy Markdown

PRDCT-370

@Iamfle4ka
Iamfle4ka marked this pull request as ready for review July 10, 2026 13:53

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 5m
  • cli/commands/remote/job/run/index.md: --timeout default 2m→5m is an unverifiable product-behaviour claim
  • cli/commands/local/persist/index.md: Diff adds kbc persist alias not mentioned in PR body; unverifiable

Suggested reviewers: @keboola/docs

Iamfle4ka and others added 2 commits August 17, 2026 16:10
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
Iamfle4ka pushed a commit to Iamfle4ka/keboola-as-code that referenced this pull request Sep 3, 2026
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.
@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Closing as moot — the pages this PR fixes are being deleted.

developers.keboola.com is being retired, and the decision (Slack, 2026-09-02/03, David Esner + Martin Vaško) is that the legacy Keboola-as-Code CLI reference is not migrated anywhere: not into help.keboola.com, and — after keboola/keboola-as-code#2654 was closed by the repo owner — not into the tool's own repository either. The deletion PR is #417.

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 keboola-as-code source while auditing the section:

  • remote job run and remote table unload/download --timeout default is 5m, not 2m
  • kbc local persist alias is pt; kbc p does not exist
  • the generated GitHub pull workflow runs hourly (0 * * * *), not every five minutes
  • dbt generate env described and demonstrated generate sources — copy-paste error
  • local create row example ran kbc create config
  • missing --cleanup on local fix-paths and --without-decompress on remote file download
  • remote file upload example used --name/--tags; the real flags are --file-name/--file-tags
  • two "remote workspace" links pointed at /commands/remote/create/

None of that survives the deletion. Recorded here so the next person auditing this CLI does not re-derive it.

@Iamfle4ka Iamfle4ka closed this Sep 3, 2026
@Iamfle4ka
Iamfle4ka deleted the devin/1782145879-PRDCT-370-cli-audit-fixes branch September 8, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants