Skip to content

[codex] Add tfy CLI reference drift checks#45

Merged
mnvsk97 merged 2 commits into
mainfrom
codex/tfy-cli-reference-onboarding
May 19, 2026
Merged

[codex] Add tfy CLI reference drift checks#45
mnvsk97 merged 2 commits into
mainfrom
codex/tfy-cli-reference-onboarding

Conversation

@mnvsk97
Copy link
Copy Markdown
Collaborator

@mnvsk97 mnvsk97 commented May 18, 2026

Summary

  • Keep the public README setup CTA as npx skills add truefoundry/skills plus the prompt sign me up for truefoundry.
  • Expand cli-reference.md from the live tfy 0.13.12 help surface, including valid nested commands and explicit invalid commands.
  • Update onboarding/prerequisite flow to check tfy --version first, then verify CLI login via credentials, then guide registration and tfy login --host <tenant-url> when missing.
  • Add scripts/check-tfy-cli-reference.sh and wire it into validate-skills.sh to catch CLI/reference drift.
  • Remove nonexistent tfy upload skill / tfy download skill guidance from the skills registry flow.
  • Polish launch docs: use raw install-instruction URLs, remove a stale AGENTS.md reference, and keep TFY_API_KEY optional in .env.example.

Launch Flow

After this PR lands on main, users can run:

npx skills add truefoundry/skills

Then in Claude Code, Codex, or Cursor they can say:

sign me up for truefoundry

That invokes truefoundry-onboard, which checks existing CLI login, sends new users to registration, collects the tenant URL, guides tfy login --host <tenant-url>, and stops after login verification.

Validation

  • ./scripts/validate-skills.sh
  • ./scripts/validate-skill-security.sh
  • ./scripts/test-tfy-api.sh
  • git diff --check
  • bash scripts/install.sh --help
  • shellcheck scripts/*.sh hooks/auto-approve-tfy-api.sh skills/_shared/scripts/tfy-api.sh plugin-scripts/*.sh
  • npx skills add truefoundry/skills --list

Note

Medium Risk
Introduces a new validation step (check-tfy-cli-reference.sh) that can fail CI/local validation when the installed tfy CLI differs from the documented surface. Functional code paths aren’t changed, but contributor workflow and docs are tightly coupled to a specific CLI version.

Overview
Keeps tfy command documentation in sync with reality. Adds scripts/check-tfy-cli-reference.sh (wired into scripts/validate-skills.sh and CONTRIBUTING) to compare tfy --help/subcommand help against an expected subcommand list, assert documented commands expose help, and ensure explicitly invalid commands still fail.

Refreshes onboarding/setup guidance and examples. Expands cli-reference.md across all skills to mirror tfy 0.13.12 (valid nested commands, global flags, and explicit “do not run” destructive commands), updates prerequisites/onboarding flow to check tfy --version before credential-based login verification, removes guidance for non-existent tfy upload/download skill, and tweaks install/setup CTAs (raw GitHub URLs, optional blank TFY_API_KEY, README prompt text).

Reviewed by Cursor Bugbot for commit 0e719b8. Bugbot is set up for automated code reviews on this repo. Configure here.

@mnvsk97 mnvsk97 marked this pull request as ready for review May 19, 2026 18:06
@mnvsk97 mnvsk97 merged commit c17cb0c into main May 19, 2026
17 checks passed
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.

2 participants