Skip to content

docs: align CLI examples with help output - #5

Open
lraveri wants to merge 1 commit into
richclement:mainfrom
lraveri:fix/docs-cli-help-alignment
Open

docs: align CLI examples with help output#5
lraveri wants to merge 1 commit into
richclement:mainfrom
lraveri:fix/docs-cli-help-alignment

Conversation

@lraveri

@lraveri lraveri commented Jun 11, 2026

Copy link
Copy Markdown

Summary

  • align skills/tfccli/SKILL.md examples with the current tfccli --help output
  • fix the same stale examples in README.md
  • correct positional IDs/names, required --workspace-id usage, and renamed or reordered commands such as plans sanitized-plan and configuration-versions upload --file ... <id>

Context

I compared the published examples against the current CLI help output and found multiple places where the docs had drifted from the actual command syntax. This can mislead both human users and coding agents that rely on these examples.

Closes #4

@lraveri

lraveri commented Jun 23, 2026

Copy link
Copy Markdown
Author

What do you think? @richclement

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.

Documentation examples are out of sync with current CLI help

1 participant