Added a user-facing CLI reference page to the documentation. - #2860
Merged
Conversation
WalkthroughThe PR adds a Vortex CLI documentation page, updates release guidance, and standardizes “CLI install command” terminology across documentation, comments, tests, and scripts. No executable behavior changes. ChangesCLI documentation and terminology alignment
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Comment |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 2.x #2860 +/- ##
==========================================
+ Coverage 88.00% 88.11% +0.10%
==========================================
Files 96 98 +2
Lines 5346 5392 +46
Branches 0 3 +3
==========================================
+ Hits 4705 4751 +46
Misses 641 641 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.vortex/cli/README.md:
- Around line 11-13: Clarify the release condition sentence in the CLI README by
replacing the duplicated “branch” phrasing with grammatical wording that clearly
states deployment occurs for branches whose names contain “release-docs” or
“release-cli,” while preserving the GitHub release condition.
In @.vortex/docs/content/cli.mdx:
- Around line 116-120: Update the “Superseded variable names” note in the CLI
documentation to describe only the current legacy-variable fallback and
replacement notice behavior. Remove the future-major-version removal guidance
from this evergreen reference, and relocate that migration detail to the
updating documentation or release notes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: bd781dee-e76d-48f6-8679-8c1ea47e4ebb
📒 Files selected for processing (25)
.docker/cli.dockerfile.vortex/CLAUDE.md.vortex/cli/CLAUDE.md.vortex/cli/README.md.vortex/cli/src/Utils/Normalizer.php.vortex/cli/tests/Functional/Command/InstallCommandTest.php.vortex/cli/tests/Functional/FunctionalTestCase.php.vortex/cli/tests/Functional/Handlers/AbstractHandlerProcessTestCase.php.vortex/cli/tests/Functional/PharTest.php.vortex/cli/tests/Unit/EnvTest.php.vortex/cli/tests/Unit/ValidatorTest.php.vortex/docs/content/cli.mdx.vortex/docs/content/contributing/maintenance/cli.mdx.vortex/docs/content/development/visual-regression.mdx.vortex/docs/content/drupal/composer-json.mdx.vortex/docs/content/faqs.mdx.vortex/docs/content/installation.mdx.vortex/docs/content/updating-vortex.mdx.vortex/docs/src/pages/index.js.vortex/tests/phpunit/Functional/AhoyWorkflowTest.php.vortex/tests/phpunit/Functional/FunctionalTestCase.php.vortex/tests/phpunit/Traits/SutTrait.php.vortex/tests/update-test-assets.vortex/tooling/src/vortex-provisionscripts/vortex-tooling.sh
Comment on lines
+11
to
+13
| The CLI is packaged as a PHAR and deployed to https://www.vortextemplate.com/install | ||
| upon each GitHub release or for every branch to a branch containing the | ||
| `release-docs` or `release-installer` in the name. | ||
| `release-docs` or `release-cli` in the name. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Clarify the release-branch sentence.
“For every branch to a branch containing” is ungrammatical and makes the deployment condition unclear.
Proposed wording
-upon each GitHub release or for every branch to a branch containing the
-`release-docs` or `release-cli` in the name.
+upon each GitHub release or for every branch whose name contains
+`release-docs` or `release-cli`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| The CLI is packaged as a PHAR and deployed to https://www.vortextemplate.com/install | |
| upon each GitHub release or for every branch to a branch containing the | |
| `release-docs` or `release-installer` in the name. | |
| `release-docs` or `release-cli` in the name. | |
| The CLI is packaged as a PHAR and deployed to https://www.vortextemplate.com/install | |
| upon each GitHub release or for every branch whose name contains | |
| `release-docs` or `release-cli`. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.vortex/cli/README.md around lines 11 - 13, Clarify the release condition
sentence in the CLI README by replacing the duplicated “branch” phrasing with
grammatical wording that clearly states deployment occurs for branches whose
names contain “release-docs” or “release-cli,” while preserving the GitHub
release condition.
Comment on lines
+116
to
+120
| :::note Superseded variable names | ||
|
|
||
| These variables were previously prefixed with `VORTEX_INSTALLER_`. The old names still work: when the current name is unset, the matching legacy name supplies the value and the run prints a notice naming its replacement. The fallback exists to ease migration and will be removed in a future major version. | ||
|
|
||
| ::: |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Move future-removal guidance to the updating documentation.
Keep the current legacy-variable fallback documented here, but move the “will be removed in a future major version” migration detail to updating-vortex.mdx or release notes so this evergreen reference describes current behavior only.
Based on learnings, evergreen reference pages under .vortex/docs/content/ should avoid breaking-change and migration details inline.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.vortex/docs/content/cli.mdx around lines 116 - 120, Update the “Superseded
variable names” note in the CLI documentation to describe only the current
legacy-variable fallback and replacement notice behavior. Remove the
future-major-version removal guidance from this evergreen reference, and
relocate that migration detail to the updating documentation or release notes.
Source: Learnings
|
Code coverage (threshold: 90%) Per-class coverage |
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
1 similar comment
Member
Author
|
Code coverage (threshold: 90%) Per-class coverage |
This was referenced Jul 29, 2026
Open
Closed
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
1 participant
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.
Summary
Adds a user-facing CLI reference page to the documentation, and clears the remaining installer naming out of the
drevops/vortex-clipackage.Why
The relocation of the installer into the
drevops/vortex-clipackage renamed everything, but the user-facing documentation only received word swaps - it still described a one-shot installer. Nothing in the user-facing docs described the CLI as a CLI: no command reference, no options, no environment variables. The only substantial CLI writing lived incontributing/maintenance/cli.mdx, which is contributor documentation, not user-facing.What
.vortex/docs/content/cli.mdx(sidebar position 4, directly after Installation) covering the three commands (installas the default,check-requirements,build), every option on each command, the non-interactive workflow (--schemato discover prompts,--validateto check answers,--promptsto supply them) and the--agent-helpAI-agent flow, theVORTEX_CLI_*andVORTEX_CLI_INSTALL_*environment variables plus theVORTEX_INSTALLER_*deprecation and fallback, and the distribution contract for/install,/v1/installand/v2/install.installation.mdxto the new page, from its intro and from the AI-agent tip; andupdating-vortex.mdxto the distribution section, for the per-major paths.installation.mdxstays a task-oriented walkthrough;cli.mdxis the reference..vortex/cli/src/Command/*.php, not written from memory - option names, short flags and descriptions match the code.Cleanup
A second commit clears the remaining installer naming inside the CLI package:
.vortex/cli/README.mdwas still titled "Vortex installer", plus stale docblocks - two of which named classes that no longer exist at all (InstallerDotEnvTest,InstallerHelpersTest). It also renames threeInstallCommandTestdata-set names from "v1 installer ..." to "v1 CLI ...".Deliberately left alone
The
VORTEX_INSTALLER_*fallback map inEnv.phpandvortex-update, the deprecation-test fixtures, and the1.xlegs ofvortex-release.ymlandvortex-test-docs.yml- each of these names the installer because the installer is what it refers to.Verification
yarn build,yarn lintandyarn spellcheck(69 files, 0 issues) all pass; the new#non-interactive-useand#distributionanchors resolve, and the only broken anchors are pre-existing ones indevelopment/variables.OK (1617 tests, 5177 assertions),composer lintclean.Screenshots
N/A
Before / After
Summary by CodeRabbit