Skip to content

Commit 253abf1

Browse files
committed
Improved help text to prioritize user-friendly URL formats.
- Direct GitHub URLs (copy from browser) shown first - # syntax promoted as primary method (shell-safe) - @ syntax moved to 'Alternative' section with warning about escaping - Reordered examples to match real-world usage patterns This better reflects the goal of issue #2162: making the URI format more user-friendly by showing the most intuitive formats first.
1 parent d7b1070 commit 253abf1

1 file changed

Lines changed: 12 additions & 17 deletions

File tree

.vortex/installer/src/Command/InstallCommand.php

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -98,29 +98,24 @@ protected function configure(): void {
9898
Non-interactively install Vortex from the latest stable release into the specified directory:
9999
php installer --no-interaction --destination=path/to/destination
100100
101-
Install Vortex from the stable branch into the specified directory:
102-
php installer --uri=https://github.com/drevops/vortex.git@stable --destination=path/to/destination
103-
104-
Install Vortex from a specific release version into the specified directory:
105-
php installer --uri=https://github.com/drevops/vortex.git@25.11.0 --destination=path/to/destination
106-
php installer --uri=https://github.com/drevops/vortex.git@1.0.0-2025.11.0 --destination=path/to/destination
107-
php installer --uri=https://github.com/drevops/vortex.git@v1.2.3 --destination=path/to/destination
108-
109-
Install Vortex from a specific commit into the specified directory:
110-
php installer --uri=https://github.com/drevops/vortex.git@abcd123 --destination=path/to/destination
111-
112-
Install Vortex from a development branch into the specified directory:
113-
php installer --uri=https://github.com/drevops/vortex.git@feature-branch --destination=path/to/destination
101+
Install from the latest stable release:
102+
php installer --uri=https://github.com/drevops/vortex.git#stable --destination=path/to/destination
114103
115-
Using direct GitHub URLs (copy from browser):
104+
Copy GitHub URL directly from your browser:
116105
php installer --uri=https://github.com/drevops/vortex/releases/tag/25.11.0 --destination=path/to/destination
117106
php installer --uri=https://github.com/drevops/vortex/tree/1.2.3 --destination=path/to/destination
107+
php installer --uri=https://github.com/drevops/vortex/tree/main --destination=path/to/destination
118108
php installer --uri=https://github.com/drevops/vortex/commit/abcd123 --destination=path/to/destination
119109
120-
Using # syntax (shell-safe alternative to @):
110+
Install using repository URL with # syntax:
121111
php installer --uri=https://github.com/drevops/vortex.git#25.11.0 --destination=path/to/destination
122-
php installer --uri=https://github.com/drevops/vortex.git#stable --destination=path/to/destination
123-
php installer --uri=git@github.com:drevops/vortex#main --destination=path/to/destination
112+
php installer --uri=https://github.com/drevops/vortex.git#v1.2.3 --destination=path/to/destination
113+
php installer --uri=https://github.com/drevops/vortex.git#main --destination=path/to/destination
114+
php installer --uri=git@github.com:drevops/vortex#stable --destination=path/to/destination
115+
116+
Alternative @ syntax (may require shell escaping):
117+
php installer --uri=https://github.com/drevops/vortex.git@25.11.0 --destination=path/to/destination
118+
php installer --uri=git@github.com:drevops/vortex@main --destination=path/to/destination
124119
EOF
125120
);
126121
$this->addOption(static::OPTION_DESTINATION, NULL, InputOption::VALUE_REQUIRED, 'Destination directory. Defaults to the current directory.');

0 commit comments

Comments
 (0)