How to configure path repository in PHP and Composer? In Composer, the path repository allows you to point directly to the local directory for development testing. To configure it, modify the composer.json file of the main project, add an entry of type path in the repositories section: { "type": "path", "url": "../relative path/to/your/package"}, and then use composer require vendor/package-name:@dev to install the package. The following points should be noted when using a path repository: 1. The path can be a relative or absolute path; 2. The target directory must have composer.json; 3. It is usually used for local development, testing internal tools or debugging issues; 4. Not suitable for production environments; 5. Automatic loading may require manual updates; 6. Git changes will affect the original package; 7. Windows needs to enable developer mode to support symbolic links. The path repository should be removed before deployment to avoid dependency resolution issues.

If you're working with PHP and Composer, using a path repository can be a helpful way to test or develop packages locally without pushing them to a remote server. It's especially useful when you're building something custom or debugging dependencies.

Here's how to set it up properly.

What is a path repository in Composer?

A path repository allows you to point Composer directly to a local directory instead of a VCS (like Git) or Packagist. This means you can work on a package and its consumer project at the same time — changes are reflected instantly without needing to commit, tag, or push anything.

This is different from typical package installation, where Composer fetches code from a remote source. With a path repo, Composer creates a symlink (or copies files if symlinks aren't supported) from your main project into the specified local directory.

How to configure a path repository

To use a path repository, you need to modify your composer.json file in the main project. Here's what you do:

In the repositories section, add a new item like this:

 {
  "type": "path",
  "url": "../relative/path/to/your/package"
}

Then, require the package just like any other Composer package:

 composer requires vendor/package-name:@dev

You'll usually want to use @dev because Composer will map the local directory as a development version.

? A few important notes:

• The path can be relative or absolute.
• Make sure the target directory has its own composer.json .
• Symlink behavior depends on your OS and Composer settings.

When should you use a path repository?

There are a few common scenarios where this comes in handy:

• Local development : You're actively developing a package and want to see changes immediately in the parent project.
• Testing internal tools : If you have shared utilities used across multiple projects, you can test them without publishing.
• Debugging issues : If a bug appears to come from a dependency, you can quickly patch it locally and verify fixes.

Just keep in mind that path repositories are not meant for production use — they're a development tool.

Gotchas and things to watch out for

While using path repositories is straightforward, there are some quirks to be aware of:

• Autoloading may not update automatically : If you change class names or files in your package, you might need to run composer dumpautoload in both the package and the main project.
• Git hooks and version control : Since the package is linked via a symlink, changes made in the main project will affect the original package directory. That's good for development but dangerous if you're not careful.
• Not all environments support symlinks : Windows users might run into issues unless Developer Mode is enabled. In those cases, Composer falls back to copying files — which means changes won't sync automatically anymore.

Also, don't forget to remove the path repository before deploying to production or sharing the project — otherwise, others won't be able to resolve the package.

That's basically it. It's not complicated, but it does require attention to detail — especially around autoloading and environment compatibility.

The above is the detailed content of How do I use a path repository as a Composer package source?. For more information, please follow other related articles on the PHP Chinese website!