jbboehr / akashi
Executable documentation testing for PHP.
Maintainers
Requires
- php: ^8.2
- composer-runtime-api: ^2.2
- league/commonmark: ^2.8.3
- nikic/php-parser: ^5.8
- symfony/process: ^7.4
Requires (Dev)
- ext-dom: *
- brianium/paratest: ^7.8.5
- friendsofphp/php-cs-fixer: ^3
- infection/infection: ^0.32.6
- phpstan/phpstan: ^2.2.5
- phpstan/phpstan-phpunit: ^2.0.13
- phpstan/phpstan-strict-rules: ^2.0
- phpunit/phpunit: ^11.5
Suggests
- phpstan/phpstan: Enables PHPStan documentation-example verification (PHPStan 2.x).
- phpunit/phpunit: Enables runtime and PHPStan test integration (PHPUnit 11.5).
This package is auto-updated.
Last update: 2026-08-08 04:42:27 UTC
README
Akashi
Akashi is a PHP project for testing examples embedded in documentation.
Status: Markdown discovery and extraction, the marked-example CLI, in-process and separate-process execution, PHPUnit integration, and PHPStan verification are implemented. The API remains provisional until the Yumemi and Yumemi Apocrypha consumer migrations pass their acceptance gates.
Installation
Akashi requires PHP 8.2 or later. Until the first tagged release, install the development branch:
composer require --dev jbboehr/akashi:dev-master
Composer installs the command as:
vendor/bin/akashi
Extract an explicitly marked PHP fence without adding decorative output:
vendor/bin/akashi extract \
--marker-name=akashi-example \
docs/pages/getting-started.md \
hello-world
Documentation
See the documentation index for current project status and development notes.
License
Akashi is licensed under AGPL-3.0-only WITH romic-exception. See LICENSE.md and the
Romic Exception. Contributions follow the terms in CONTRIBUTING.md.