README

SugarSkate

PHP port of charmbracelet/skate — a personal key/value store with multi-database support, binary data handling, and glob/list filtering.

Features

Multi-database — separate stores with @dbname suffix, auto-created on first use
Binary data — safely stores and retrieves raw binary (images, files) via base64 encoding
Glob pattern matching — list/get/delete keys using * and ? wildcards
Ordered listing — forward or reverse lexicographic order
Flexible listing — keys only, values only, or key-value pairs
SQLite-backed — one SQLite DB per database, stored in $XDG_CONFIG_HOME/skate/ or ~/.config/skate/
PHP 8.1+ — pure PHP, no extension required beyond SQLite (php-sqlite3)
Iterable streams — list() yields results without loading everything into memory
TTL / expiry — set keys that automatically expire after a given number of seconds
Levenshtein suggestions — typo suggestions on key miss (get command prints to stderr)
Import/Export — bulk load or save entries in JSON or YAML format, with optional atomic transaction
Atomic transactions — Database::transaction() wraps a callback in BEGIN/COMMIT/ROLLBACK

Install

composer require sugarcraft/sugar-skate

Quick Start

use SugarCraft\Skate\Store;

$skate = new Store();

// Set and get
$skate->set('greeting', 'Hello, World!');
echo $skate->get('greeting'); // Hello, World!

// With a database
$skate->set('token', 'ghp_xxxx', 'passwords');
echo $skate->get('token', 'passwords');

// List all keys
foreach ($skate->list() as $entry) {
    echo "{$entry->key} => {$entry->value}\n";
}

// Glob patterns
foreach ($skate->list(pattern: 'user-*') as $entry) { ... }

// Delete
$skate->delete('greeting');

CLI

skate set <key> [value] [--ttl=SECONDS]          # Set a key (reads stdin if no value)
skate get <key>                                # Get a value (suggests typo on miss)
skate list [-k|-v] [-r] [-d delim] [pattern]   # List entries
skate delete <key>                              # Delete a key (glob patterns supported)
skate list-dbs                                   # Show all databases
skate import <json|yaml> <path> [--no-atomic]   # Import entries (path=- for STDIN)
skate export <json|yaml> [db] [pattern]         # Export entries

TTL (Time-To-Live)

Use --ttl to set keys that automatically expire:

skate set session:abc123 '{"user":"bob"}' --ttl=3600  # expires in 1 hour

STDIN

When no value is given as an argument, set reads from stdin. For import, use - or /dev/stdin as the path:

echo "my-secret-token" | skate set api-token
skate import json - < backup.json

Import / Export

Import and export support JSON and YAML formats. Import runs inside an atomic transaction by default; pass --no-atomic to disable:

skate import json backup.json
skate import yaml -             # read from STDIN
skate export json > dump.json
skate export yaml mydb 'user-*'  # export filtered keys from a specific database

The export output includes remaining TTL as a _ttl top-level key in JSON, or skate_ttl_<key> entries in YAML.

Data Directory

Default: ~/.config/skate/ (respects $XDG_CONFIG_HOME).

Each database gets its own SQLite file: ~/.config/skate/<dbname>.db.

Demos

Glob pattern matching

Shared foundations

sugar-skate uses candy-fuzzy for Smith-Waterman scored matching infrastructure. The matcher is wired for future fuzzy key search; glob-to-SQLIKE pattern filtering remains the active filter path today.

License

MIT

sugarcraft / sugar-skate

Maintainers

Package info

Statistics

Security