Installation

PHAR (recommended)Composer (optional)

Download the latest release as a self-contained PHAR file:

curl -Lo sputnik.phar https://github.com/refsz/sputnik/releases/latest/download/sputnik.phar
chmod +x sputnik.phar

Verify the checksum:

curl -Lo sputnik.phar.sha256 https://github.com/refsz/sputnik/releases/latest/download/sputnik.phar.sha256
sha256sum -c sputnik.phar.sha256

Run with:

php sputnik.phar <command>

If you want IDE autocompletion when writing tasks:

composer require --dev refs/sputnik

Run with:

vendor/bin/sputnik <command>

Tip

The PHAR is the recommended way to run Sputnik. Composer install is optional and primarily useful for IDE autocompletion. You can use both together -- Composer for class definitions, PHAR for execution.

Requirements

Note

PHP 8.3 or higher is required.

Next

• Quick Start -- initialize a project and run your first task
• CLI Reference -- all commands and flags