https://github.com/shivammathur/spc
setup-php-cli (spc) is a command line utility to run setup-php.
https://github.com/shivammathur/spc
cli github-actions php setup-php
Last synced: 4 months ago
JSON representation
setup-php-cli (spc) is a command line utility to run setup-php.
- Host: GitHub
- URL: https://github.com/shivammathur/spc
- Owner: shivammathur
- License: mit
- Created: 2020-11-15T11:47:16.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-17T10:44:48.000Z (6 months ago)
- Last Synced: 2025-05-13T01:38:26.551Z (5 months ago)
- Topics: cli, github-actions, php, setup-php
- Language: Shell
- Homepage: https://packagist.org/packages/shivammathur/spc
- Size: 37.1 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SPC
setup-php-cli (SPC) is a command line utility to run [setup-php](https://github.com/shivammathur/setup-php).
## OS Support
|Host OS/Virtual environment|PHP Supported|
|--- |--- |
|Ubuntu 24.04|`PHP 5.6` to `PHP 8.4`|
|Ubuntu 22.04|`PHP 5.6` to `PHP 8.4`|
|Windows with cygwin|`PHP 5.6` to `PHP 8.4`|
|macOS Sequoia 15.x|`PHP 5.6` to `PHP 8.4`|
|macOS Sonoma 14.x|`PHP 5.6` to `PHP 8.4`|
|macOS Ventura 13.x|`PHP 5.6` to `PHP 8.4`|
## Install
- Using composer
```bash
composer global require shivammathur/spc
sudo cp $(composer global config home)/vendor/bin/spc /usr/local/bin/spc
sudo chmod a+x /usr/local/bin/spc
```
- Download from Releases
```bash
# Download
curl -o /tmp/spc -sL https://github.com/shivammathur/spc/releases/latest/download/spc
# Verify
curl -o /tmp/spc.asc -sL https://github.com/shivammathur/spc/releases/latest/download/spc.asc
curl -o /tmp/key.asc -sL https://github.com/shivammathur.gpg
gpg --import /tmp/key.asc
gpg --verify /tmp/spc.asc /tmp/spc
# Install
sudo mv /tmp/spc /usr/local/bin/spc
sudo chmod a+x /usr/local/bin/spc
```
## Options
```bash
-p "[PHP Version]", --php-version "[PHP Version]" Specify PHP version (Required if PHP is not installed)
-e "[Extensions]", --extensions "[Extensions]" Specify extensions
-b "[INI File]", --ini-file "[INI Values]" Specify base ini file
-i "[INI Values]", --ini-values "[INI Values]" Specify ini values
-c "[Coverage]", --coverage "[Coverage]" Specify Coverage driver
-t "[Tools]", --tools "[Tools]" Specify tools
-f "[Debug]", --debug "[Debug]" Specify debug flag
-f "[Fail Fast]", --fail-fast "[Fail Fast]" Specify fail-fast flag
-z "[PHP TS/NTS]", --phpts "[PHPTS/NTS]" Specify phpts flag
-u "[Update]", --update "[Update]" Specify update flag
-r "[TAG]", --release "[TAG]" Specify release
-v, --verbose Specify verbose mode
-V, --version Show version of script
-h, --help Show help
```
## Examples
- Install or switch to a particular PHP version. For example to install `PHP 7.4`.
```bash
spc -p "7.4"
```
- Install PHP extension, say `intl` and `xml` on `PHP 7.4`.
```bash
spc -e "intl, xml"
```
- Set the base php.ini file, say set it to `development`.
```bash
spc -b "development"
```
- Add any configuration to your php.ini, say set timezone to `UTC`.
```bash
spc -i "date.timezone=UTC"
```
- Set a coverage driver, say `PCOV`.
```bash
spc -c "pcov"
```
- Install a tool supported by `setup-php` globally.
```bash
spc -t "phpunit"
```
- Setup a debug build of PHP.
```bash
spc -p 8.1 -d "true"
```
- Fail if an extension, or a tool does not install.
```bash
spc -t "random_tool" -f "true"
```
- Update PHP to the latest patch version.
```bash
spc -u "true"
```
- Setup TS/NTS PHP on `Windows`. (Not supported currently)
```bash
spc -p "7.4" -z "ts"
```
- Use a particular tag/release of `setup-php`, say to use `v1`.
```bash
spc -r "v1"
```
- To run `spc` in the verbose mode, this will use `verbose` branch of `setup-php`.
```bash
spc -v
```
- To check options spc supports in command line.
```bash
spc -h
```
- To upgrade `spc` to latest version.
```bash
spc -U
```
- To check `spc` version.
```bash
spc -V
```