Introduction

You can use the serve command to serve any phpkg package without installing it into any project. Just pass the git URL for your desired package and start serving in your local.

Note The serve command uses php pcntl extension, which is not supported on Windows operating systems.

Note The package that you want to serve must have at least one entry point defined in its config file.

Usage

You need to pass the package's git URL to the serve command. This command works with both, HTTPS and SSH git URL.

The serve command downloads, installs, builds, and serves the first entry point using php -S command.

phpkg serve https://github.com/{OWNER}/{REPO}.git [entry-point]

Note If the given package has more than one entry point defined in its phpkg.config.json file, then you need to pass a second argument to specify which entry point you need to run. Otherwise, it uses the first entry point defined in the config file. See customization documents

As an example, you can serve the Daily Routine package that shows a simple dashboard with various information to start your day, by running the following command:

phpkg serve https://github.com/php-repos/daily-routine.git

It's worth noting that the serve command will install the package in a temporary location, and it will be removed after restarting your OS. Also, it will not add the package to your phpkg.config.json file, so it will not be available for future use in your application.

You may wish to serve a package on a specific version. For doing so, pass a version arg indicating your desired version:

phpkg serve https://github.com/owner/repo.git --version={version}

If you came across a need to serve a package on a specific commit hash, you can use the version argument using development#{commit-hash}:

phpkg serve https://github.com/php-repos/daily-routine.git --version=development#f2ffcee641009d753c72a935a083b2fc650787c1

While developing, you might need to serve another package that is already on your machine. In this case, you can use either a relative or an absolute path to the project from your current directory, rather than the package's URL:

phpkg serve ../relative/path/to/packge
phpkg serve ./absolute/path/to/package