aellopus/client

Official Aellopus client for PHP — a synchronous, zero-dependency AWP/1 client.

v1.0.0 2026-06-26 09:24 UTC

Requires

• php: ^8.2

Requires (Dev)

• laravel/pint: ^1.0
• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11.0

Apache-2.0

• database
• cache
• client
• key-value
• kv
• aellopus
• awp

README

Official, synchronous, zero-dependency PHP client for Aellopus over the AWP/1 wire protocol.

Stable. See CHANGELOG.md for release notes.

Requirements

• PHP ^8.2 (64-bit)

Install

composer require aellopus/client

Usage

use Aellopus\Client\Client;
use Aellopus\Client\Exception\NotFoundError;

$client = Client::connect('127.0.0.1:6969'); // timeoutMs defaults to 5000

$client->set('user:1', 'John');
echo $client->get('user:1');                 // "John"

try {
    $client->get('absent');
} catch (NotFoundError) {
    // a miss is distinct from an empty value
}

$client->set('counter', '0');
$client->incr('counter');                     // 1

// Lazily walk the keyspace:
foreach ($client->scan('user:*') as $key) {
    echo $key, PHP_EOL;
}

$client->close();

Values are raw bytes — they may contain CR, LF, or NUL and round-trip byte-exact. An empty string "" is a stored value (a hit), never a miss.

License

Apache-2.0