diff --git a/README-zh.md b/README-zh.md index d8d1b3964..540828e3c 100755 --- a/README-zh.md +++ b/README-zh.md @@ -1,24 +1,24 @@ -# static-php-cli +# StaticPHP -[![English readme](https://img.shields.io/badge/README-English%20%F0%9F%87%AC%F0%9F%87%A7-moccasin?style=flat-square)](README.md) [![Chinese readme](https://img.shields.io/badge/README-%E4%B8%AD%E6%96%87%20%F0%9F%87%A8%F0%9F%87%B3-moccasin?style=flat-square)](README-zh.md) +[![English readme](https://img.shields.io/badge/README-English%20%F0%9F%87%AC%F0%9F%87%A7-moccasin?style=flat-square)](README.md) [![Releases](https://img.shields.io/packagist/v/crazywhalecc/static-php-cli?include_prereleases&label=Release&style=flat-square)](https://github.com/crazywhalecc/static-php-cli/releases) [![CI](https://img.shields.io/github/actions/workflow/status/crazywhalecc/static-php-cli/tests.yml?branch=main&label=Build%20Test&style=flat-square)](https://github.com/crazywhalecc/static-php-cli/actions/workflows/tests.yml) [![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://github.com/crazywhalecc/static-php-cli/blob/main/LICENSE) -**static-php-cli** 是一个用于构建静态、独立 PHP 运行时的强大工具，支持众多流行扩展。 +**StaticPHP**（原名 **static-php-cli**）是一个用于构建静态、独立 PHP 运行时的强大工具，支持众多流行扩展。 ## 特性 - :elephant: **支持多 PHP 版本** - 支持 PHP 8.1, 8.2, 8.3, 8.4, 8.5 - :handbag: **单文件 PHP 可执行文件** - 构建零依赖的独立 PHP -- :hamburger: **phpmicro 集成** - 构建 **[phpmicro](https://github.com/dixyes/phpmicro)** 自解压可执行文件（将 PHP 二进制文件和源代码合并为一个文件） +- :hamburger: **phpmicro 集成** - 构建 **[phpmicro](https://github.com/static-php/phpmicro)** 自解压可执行文件（将 PHP 二进制文件和源代码合并为一个文件） - :pill: **智能环境检查器** - 自动构建环境检查器，具备自动修复功能 - :zap: **跨平台支持** - 支持 Linux、macOS、FreeBSD 和 Windows - :wrench: **可配置补丁** - 可自定义的源代码补丁系统 - :books: **智能依赖管理** - 自动处理构建依赖 - 📦 **自包含工具** - 提供使用 [box](https://github.com/box-project/box) 构建的 `spc` 可执行文件 -- :fire: **广泛的扩展支持** - 支持 75+ 流行 [扩展](https://static-php.dev/zh/guide/extensions.html) +- :fire: **广泛的扩展支持** - 支持 100+ 流行 [扩展](https://static-php.dev/zh/guide/extensions.html) - :floppy_disk: **UPX 压缩** - 减小二进制文件大小 30-50%（仅 Linux/Windows） **单文件独立 php-cli：** @@ -33,6 +33,8 @@ ### 1. 下载 spc 二进制文件 +`spc` 二进制文件是 StaticPHP 项目的 CLI 工具，打包为单个可执行文件。 + ```bash # Linux x86_64 curl -fsSL -o spc https://dl.static-php.dev/static-php-cli/spc-bin/nightly/spc-linux-x86_64 @@ -107,7 +109,7 @@ buildroot/bin/php-fpm -v 以下是几个具有不同扩展组合的预编译静态 PHP 二进制文件， 您可以根据需要直接下载。 -| 组合名称 | 扩展数量 | 系统 | 备注 | +| 组合名称 | 扩展数量 | 系统 | 备注 | |----------------------------------------------------------------------|----------------------------------------------------------------------------|--------------|--------------------| | [common](https://dl.static-php.dev/static-php-cli/common/) | [30+](https://dl.static-php.dev/static-php-cli/common/README.txt) | Linux, macOS | 二进制文件大小约为 7.5MB | | [bulk](https://dl.static-php.dev/static-php-cli/bulk/) | [50+](https://dl.static-php.dev/static-php-cli/bulk/README.txt) | Linux, macOS | 二进制文件大小约为 25MB | diff --git a/README.md b/README.md index 3f3bfbf1e..65e5af372 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# static-php-cli +# StaticPHP [![Chinese readme](https://img.shields.io/badge/README-%E4%B8%AD%E6%96%87%20%F0%9F%87%A8%F0%9F%87%B3-moccasin?style=flat-square)](README-zh.md) [![English readme](https://img.shields.io/badge/README-English%20%F0%9F%87%AC%F0%9F%87%A7-moccasin?style=flat-square)](README.md) @@ -6,14 +6,13 @@ [![CI](https://img.shields.io/github/actions/workflow/status/crazywhalecc/static-php-cli/tests.yml?branch=main&label=Build%20Test&style=flat-square)](https://github.com/crazywhalecc/static-php-cli/actions/workflows/tests.yml) [![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://github.com/crazywhalecc/static-php-cli/blob/main/LICENSE) -**static-php-cli** is a powerful tool designed for building static, standalone PHP runtime -with popular extensions. +**StaticPHP** (formerly **static-php-cli**) is a powerful tool designed for building static, standalone PHP runtime with popular extensions. ## Features - :elephant: Support multiple PHP versions - PHP 8.1, 8.2, 8.3, 8.4, 8.5 - :handbag: Build single-file PHP executable with zero dependencies -- :hamburger:Build **[phpmicro](https://github.com/dixyes/phpmicro)** self-extracting executables (combines PHP binary and source code into one file) +- :hamburger:Build **[phpmicro](https://github.com/static-php/phpmicro)** self-extracting executables (combines PHP binary and source code into one file) - :pill: Automatic build environment checker with auto-fix capabilities - :zap: `Linux`, `macOS`, `FreeBSD`, `Windows` support - :wrench: Configurable source code patching @@ -34,6 +33,8 @@ with popular extensions. ### 1. Download spc binary +`spc` binary is StaticPHP CLI tool packaged as a single executable file. + ```bash # For Linux x86_64 curl -fsSL -o spc https://dl.static-php.dev/static-php-cli/spc-bin/nightly/spc-linux-x86_64 @@ -53,7 +54,7 @@ For macOS and Linux, add execute permission first: chmod +x ./spc ``` -### 2. Build Static PHP +### 2. Build standalone PHP binaries First, create a `craft.yml` file and specify which extensions you want to include from [extension list](https://static-php.dev/en/guide/extensions.html) or [command generator](https://static-php.dev/en/guide/cli-generator.html): @@ -79,7 +80,7 @@ Run command: ./spc craft --debug ``` -### 3. Static PHP usage +### 3. Using the built binaries Now you can copy binaries built by static-php-cli to another machine and run with no dependencies: @@ -105,7 +106,7 @@ see . If you don't want to build or want to test first, you can download example pre-compiled artifact from [Actions](https://github.com/static-php/static-php-cli-hosted/actions/workflows/build-php-bulk.yml), or from self-hosted server. -Below are several precompiled static-php binaries with different extension combinations, +Below are several precompiled statically built php binaries with different extension combinations, which can be downloaded directly according to your needs. | Combination | Extension Count | OS | Comment | diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 8ddc9c1f2..14513abad 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -4,7 +4,7 @@ import sidebarZh from "./sidebar.zh"; // https://vitepress.dev/reference/site-config export default { - title: "Static PHP", + title: "StaticPHP", description: "Build single static PHP binary, with PHP project together, with popular extensions included.", locales: { en: { diff --git a/docs/en/guide/index.md b/docs/en/guide/index.md index 54e7840c5..3308d4100 100644 --- a/docs/en/guide/index.md +++ b/docs/en/guide/index.md @@ -1,6 +1,6 @@ # Guide -Static php cli is a tool used to build statically compiled PHP binaries, +StaticPHP is a tool used to build statically compiled PHP binaries, currently supporting Linux and macOS systems. In the guide section, you will learn how to use static php cli to build standalone PHP programs. @@ -14,12 +14,14 @@ In the guide section, you will learn how to use static php cli to build standalo The following is the architecture support situation, where :gear: represents support for GitHub Action build, :computer: represents support for local manual build, and empty represents temporarily not supported. -| | x86_64 | aarch64 | -|---------|-------------------|-------------------| -| macOS | :gear: :computer: | :gear: :computer: | -| Linux | :gear: :computer: | :gear: :computer: | -| Windows | :gear: :computer: | | -| FreeBSD | :computer: | :computer: | +| | x86_64 | aarch64 | +|---------|------------------------|------------------------| +| macOS | :gear: :computer: | :gear: :computer: | +| Linux | :gear: :computer: | :gear: :computer: | +| Windows | :gear: :computer: | | +| FreeBSD | :computer: (:warning:) | :computer: (:warning:) | + +> Due to lack of users and testing, FreeBSD is no longer supported in latest StaticPHP project. Current supported PHP versions for compilation: @@ -29,17 +31,17 @@ Current supported PHP versions for compilation: > > :x: Not supported -| PHP Version | Status | Comment | -|-------------|--------------------|-------------------------------------------------------------------------------------------------------------------------| -| 7.2 | :x: | | -| 7.3 | :x: | phpmicro and many extensions do not support 7.3, 7.4 versions | -| 7.4 | :x: | phpmicro and many extensions do not support 7.3, 7.4 versions | -| 8.0 | :warning: | PHP official has stopped maintaining 8.0, we no longer handle 8.0 related backport support | -| 8.1 | :warning: | PHP official only provides security updates for 8.1, we no longer handle 8.1 related backport support after 8.5 release | -| 8.2 | :heavy_check_mark: | | -| 8.3 | :heavy_check_mark: | | -| 8.4 | :heavy_check_mark: | | -| 8.5 (beta) | :warning: | PHP 8.5 is currently in beta stage | +| PHP Version | Status | Comment | +|-------------|--------------------|--------------------------------------------------------------------------------------------| +| 7.2 | :x: | | +| 7.3 | :x: | phpmicro and many extensions do not support 7.3, 7.4 versions | +| 7.4 | :x: | phpmicro and many extensions do not support 7.3, 7.4 versions | +| 8.0 | :warning: | PHP official has stopped maintaining 8.0, we no longer handle 8.0 related backport support | +| 8.1 | :warning: | PHP official only provides security updates for 8.1 | +| 8.2 | :heavy_check_mark: | | +| 8.3 | :heavy_check_mark: | | +| 8.4 | :heavy_check_mark: | | +| 8.5 | :heavy_check_mark: | | > This table shows the support status of static-php-cli for building corresponding versions, not the PHP official support status for that version. diff --git a/docs/en/index.md b/docs/en/index.md index 7d80bf2f7..5b589385a 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -3,7 +3,7 @@ layout: home hero: - name: "Static PHP" + name: "StaticPHP" tagline: "Build standalone PHP binary on Linux, macOS, FreeBSD, Windows, with PHP project together, with popular extensions included." image: src: /images/static-php_nobg.png @@ -14,9 +14,9 @@ hero: link: ./guide/ features: - - title: Static CLI Binary + - title: Static PHP Binary details: You can easily compile a standalone php binary for general use. Including CLI, FPM sapi. - - title: Micro Self-Extracted Executable + - title: PHP micro Self-Extracted Executable details: You can compile a self-extracted executable and build with your php source code. - title: Dependency Management details: static-php-cli comes with dependency management and supports installation of different types of PHP extensions. diff --git a/docs/index.md b/docs/index.md index b2b25dedf..728451044 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,7 +3,7 @@ layout: home hero: - name: "Static PHP" + name: "StaticPHP" tagline: "Build standalone PHP binary on Linux, macOS, FreeBSD, Windows, with PHP project together, with popular extensions included." image: src: /images/static-php_nobg.png diff --git a/docs/zh/guide/index.md b/docs/zh/guide/index.md index 8e5727c2a..ea984880d 100644 --- a/docs/zh/guide/index.md +++ b/docs/zh/guide/index.md @@ -12,12 +12,14 @@ static-php-cli 是一个用于构建静态编译的 PHP 二进制的工具，目 下面是架构支持情况，:gear: 代表支持 GitHub Action 构建，:computer: 代表支持本地构建，空 代表暂不支持。 -| | x86_64 | aarch64 | -|---------|-------------------|-------------------| -| macOS | :gear: :computer: | :gear: :computer: | -| Linux | :gear: :computer: | :gear: :computer: | -| Windows | :gear: :computer: | | -| FreeBSD | :computer: | :computer: | +| | x86_64 | aarch64 | +|---------|------------------------|------------------------| +| macOS | :gear: :computer: | :gear: :computer: | +| Linux | :gear: :computer: | :gear: :computer: | +| Windows | :gear: :computer: | | +| FreeBSD | :computer: (:warning:) | :computer: (:warning:) | + +> 由于缺乏用户和测试，FreeBSD 在最新的 StaticPHP 项目中不再受支持。 当前支持编译的 PHP 版本： @@ -27,17 +29,17 @@ static-php-cli 是一个用于构建静态编译的 PHP 二进制的工具，目 > > :x: 不支持 -| PHP Version | Status | Comment | -|-------------|--------------------|---------------------------------------------------------| -| 7.2 | :x: | | -| 7.3 | :x: | phpmicro 和许多扩展不支持 7.3、7.4 版本 | -| 7.4 | :x: | phpmicro 和许多扩展不支持 7.3、7.4 版本 | -| 8.0 | :warning: | PHP 官方已停止 8.0 的维护，我们不再处理 8.0 相关的 backport 支持 | -| 8.1 | :warning: | PHP 官方仅对 8.1 提供安全更新，在 8.5 发布后我们不再处理 8.1 相关的 backport 支持 | -| 8.2 | :heavy_check_mark: | | -| 8.3 | :heavy_check_mark: | | -| 8.4 | :heavy_check_mark: | | -| 8.5 (beta) | :warning: | PHP 8.5 目前处于 beta 阶段 | +| PHP Version | Status | Comment | +|-------------|--------------------|----------------------------------------------| +| 7.2 | :x: | | +| 7.3 | :x: | phpmicro 和许多扩展不支持 7.3、7.4 版本 | +| 7.4 | :x: | phpmicro 和许多扩展不支持 7.3、7.4 版本 | +| 8.0 | :warning: | PHP 官方已停止 8.0 的维护，我们不再处理 8.0 相关的 backport 支持 | +| 8.1 | :warning: | PHP 官方仅对 8.1 提供安全更新 | +| 8.2 | :heavy_check_mark: | | +| 8.3 | :heavy_check_mark: | | +| 8.4 | :heavy_check_mark: | | +| 8.5 | :heavy_check_mark: | | > 这个表格的支持状态是 static-php-cli 对构建对应版本的支持情况，不是 PHP 官方对该版本的支持情况。