Download the PHP package hojabbr/laravel-cliproxy without Composer
On this page you can find all versions of the php package hojabbr/laravel-cliproxy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hojabbr/laravel-cliproxy
More information about hojabbr/laravel-cliproxy
Files in hojabbr/laravel-cliproxy
Package laravel-cliproxy
Short Description CLIProxyAPI for Laravel: a laravel/ai driver over either wire protocol, gateway-first routing with a fallback of your choice, the management API, and batches run as queued calls.
License MIT
Homepage https://github.com/hojabbr/laravel-cliproxy
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-cliproxy
laravel-cliproxy
CLIProxyAPI for Laravel.
CLIProxyAPI is a self-hosted AI gateway. It serves the common API formats on one endpoint and routes each model to whatever you configure behind it: API keys, OpenAI-compatible providers, and the logins its panel supports, with pools, cooldowns and fallbacks. This package makes that gateway a first-class citizen of a Laravel application:
- A laravel/ai provider,
cliproxy, for text (prompts, streaming, tools, structured output, image and document attachments) and image generation. - Routing with a fallback: send a call through the gateway when it is switched on and serves the model, and to any other laravel/ai provider when it is not.
- Readiness: whether the gateway answers and which models it serves, cached.
- The management API: client keys, credentials, quota windows and config.
- Batches over a gateway that has none: create, poll, collect and cancel, run as queued calls.
cliproxy:statusandcliproxy:probe: see what the gateway serves, and prove what a model behind it can actually do before you point work at it.
The package is vendor-neutral. It speaks the gateway's wire protocols, never an upstream's; which vendor serves a model is decided in your gateway, not here.
Requirements
- PHP 8.3 or newer, Laravel 12 or 13, laravel/ai 1.x
- A running CLIProxyAPI (see Running a gateway). Supported and tested: v7.3.x.
Install
Publish the config when you want to change a default, and the migration when you use batches:
Text and images through laravel/ai
The package registers a cliproxy entry under ai.providers when you have not declared one. Its
URL and key come from cliproxy.url and cliproxy.key when the provider is first resolved, so
values your application sets during boot are honoured.
Model names are whatever your gateway serves (often an alias you defined in its panel). To give
the provider defaults, and to pick its wire protocol, declare the entry yourself in config/ai.php:
Choosing a protocol
The gateway accepts both and translates either to the upstream that serves the model.
chat-completions (default) |
messages |
|
|---|---|---|
| Endpoint | /v1/chat/completions |
/v1/messages |
| Text, streaming, tools, images | yes | yes |
| Structured output | yes | depends on the upstream (see below) |
| Documents (PDF) | as file parts |
as document blocks, depends on the upstream |
| Explicit prompt-cache breakpoints | no (upstreams that cache do so on the prefix) | yes, including #[CacheInstructions] and the moving breakpoint below |
Known gateway limit (CLIProxyAPI v7.3.18). A messages request bound for an
openai-compatibility upstream loses its document blocks and its structured-output format without
an error; text, images, tools and streaming survive. chat-completions carries both to every
upstream. Run cliproxy:probe for each model and protocol you depend on; the package's scheduled
live suite tracks this against the newest gateway.
A cache breakpoint that follows the conversation
On the messages protocol, an agent loop re-sends the whole conversation every step. Ask for a
breakpoint on the last message and each step's cache becomes a prefix of the next:
The option never reaches the wire. The trait behind it, Ai\Concerns\CachesTrailingMessage, works
on any subclass of laravel/ai's gateway for this format.
Images
Images use chat/completions with the image modality (the OpenRouter convention), which the
gateway forwards to an openai-compatibility upstream flagged image: true.
Failover
A gateway failure that another provider could answer (no connection, 429, 500, 502, 503, 504) raises laravel/ai's failover exceptions, so a provider map moves on:
The gateway answers 500 when every credential in a pool failed, so this package treats 500 as a failover where laravel/ai's own gateways do not.
Routing: gateway first, fallback of your choice
A route decides, per call, whether the gateway takes it: only when the route is on and the gateway currently serves the model. Otherwise the call goes to the fallback.
A route that is on for a model the gateway does not list, with no fallback, still goes to the
gateway, so you see the gateway's own error. A route that is off with no fallback throws
RouteUnavailable.
Readiness
The answer comes from /v1/models and is cached for cliproxy.readiness.ttl seconds (60), so a
route decision costs a cache read and a dead gateway is asked once a minute.
The management API
Answers are arrays exactly as the gateway sends them: this API moves with CLIProxyAPI's releases.
Batches
CLIProxyAPI has no batch endpoint. CliProxy::batches() keeps one row per request and runs each as
a queued call in cliproxy.batches.protocol, with the lifecycle you know from vendor batch APIs:
- A retryable failure (no connection, 408, 409, 429, 5xx) goes back on the queue after
backoff, up totries; anything else is stored aserroredwith its type and message. - A request its batch outlived (
expires_after_hours) expires;cancel()stops what has not started, and a running request finishes and keeps its answer. BatchRequestFinishedfires per request,BatchEndedonce per batch.- Finished rows are prunable: schedule
model:prune --model="Hojabbr\CliProxy\Batches\BatchRequest". cliproxy.batches.timeoutmust stay under your queue connection'sretry_after. Throughput is your workers': size the queue named incliproxy.batches.queuefor the gateway's limits.
There is no batch discount to be had through a gateway: a batch costs what its calls cost.
Commands
The probe checks listing, text, streaming, tools, structured output, image input, PDF input and caching (advisory), and optionally a long answer and image generation. It exits non-zero when a required check fails, so it can gate a deploy.
Testing your application
Fake the calls themselves with Http::fake() or laravel/ai's own fakes.
Running a gateway
docs/deploy/ has two examples with the recommended first config:
compose.yaml: CLIProxyAPI next to your application, config and login tokens in Postgres.kubernetes.yaml: one replica (login tokens refresh in place and must not race), non-root, read-only root filesystem.
With PGSTORE_DSN set, CLIProxyAPI copies config.example.yaml into Postgres only while its config
table is empty, so mount your seed at that path: from the first boot on, the panel owns the config
and a restart never overwrites an edit.
Versioning
Semantic Versioning. Below 1.0.0 a breaking change lands in a new minor, so pin with ^0.1 and read
CHANGELOG.md before moving between minors.
License
MIT. See LICENSE.md.
All versions of laravel-cliproxy with dependencies
illuminate/console Version ^12.0|^13.0
illuminate/contracts Version ^12.0|^13.0
illuminate/database Version ^12.0|^13.0
illuminate/http Version ^12.0|^13.0
illuminate/queue Version ^12.0|^13.0
illuminate/support Version ^12.0|^13.0
laravel/ai Version ^1.0