PHPackages j-angnoe/harness - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. j-angnoe/harness ActiveLibrary j-angnoe/harness ================ Runs prototypes and tools 012PHP Since Aug 9Pushed 3y ago1 watchersCompare [ Source](https://github.com/j-angnoe/harness)[ Packagist](https://packagist.org/packages/j-angnoe/harness)[ RSS](/packages/j-angnoe-harness/feed)WikiDiscussions master Synced today READMEChangelogDependenciesVersions (1)Used By (0) Harness ======= [](#harness) Quick prototyping, create a directory, create some html, php and stylesheets and fiddle with your prototype in the browser. Your prototype may make use of Vue (2.6), VueRouter, [vue-blocks](//github.com/j-angnoe/vue-blocks)and it will contain an api bridge to call functions on your defined php objects. Example ------- [](#example) ``` My Prototype Retrieved data: {{serverData}} export default { async mounted() { var arg1 = 'arg1'; var arg2 = 'some value'; this.serverData = await api.controller.getMyData(arg1, arg2); } } ``` Installation ------------ [](#installation) ### Via composer [](#via-composer) ``` # Add to project composer require j-angnoe/harness # Use inside project: vendor/bin/harness # Or install globally composer global require j-angnoe/harness:@dev # Make sure the global composer path is inside path PATH="$PATH:~$HOME/.config/composer/vendor/bin"; ``` ### Installation method 2: harness.phar [](#installation-method-2-harnessphar) ``` # Get the harness executable wget https://github.com/j-angnoe/toolkit/raw/master/harness/build/harness.phar # Make it executable chmod +x harness.phar # Create a symlink ins\ /usr/local/bin so you can access it anywhere from the commandline sudo ln -sf harness.phar /usr/local/bin/harness # Now get yourself a harness and register it as default harness. # for instance https://github.com/j-angnoe/toolkit/tree/master/vue-default-harness cd /path/to/my-default-harness; harness register; ``` Usage ----- [](#usage) ``` # Spin up a webserver that will serve your directory harness [directory] # Execute a controller method harness exec [controller] [method] [...args] harness exec [filename] [method] [...args] harness run # alias for exec # Building `bundle.js` files for your tools npm install -g parcel; # Parcel is a nice companion for prototyping cd my-tool; harness build . # one time build harness watch . # continious building # Creating a harness tool harness init my-tool; cd my-tool; # start working on your tool harness register; # Run this inside a default harness you want to use as default. harness settings; # Open the harness-settings.json file in `code` # Harnass options harnass [directory] --port # Which port to run --no-browser # Dont open a browser window --tool # Specify tool directory (instead of assuming [directory] is a tool) ``` Embedding tools in existing projects ------------------------------------ [](#embedding-tools-in-existing-projects) Some insights into how to embed can be found in [docs/embedding.md](docs/embedding.md) Requirements ------------ [](#requirements) - linux (developed on ubuntu, tested on mac). - php 7.4 - a browser (either firefox or via mac's open command) or set environment variable HARNESS\_BROWSER\_COMMAND - code (launch editor for harness settings) ### Nice to haves [](#nice-to-haves) - the fd command - parcel (npmjs.org/parcel) for automagic bundle building ### Handling oploads [](#handling-oploads) When a POST (multipart/form-data) to /upload is encountered, harness will try to call a static method `harnessUpload` on your default controller. ``` // Clientside: // Create a form that posts to `/upload` // Server side: /** * Create a function called `harnessUpload` **/ function harnessUpload($arrayOfUploadedFiles = null) { foreach ($arrayOfUploadedFiles as $file) { // do your moving magic: // move_uploaded_file($file['tmp_name'], '/somewhere/' . $file['name']); } } /** * The arrayOfUploadedFiles is an array and supports single and multiple uploads. * Each element of $files is an associative array with these keys: * - name, type, tmp_name, size, error (see PHP Uploaded Files for more info). * * Of course you may ignore this argument and work directly with PHP's $_FILES global * if you so desire. **/ ``` Serving and downloading files ----------------------------- [](#serving-and-downloading-files) Harness will link /download/FILENAME to Controller::harnessDownload($filename) and will link /dist/FILENAME to Controller::harnessServe($filename) These functions must return a valid filename to be served by Harness. Harness will do some mime-magick for you so you dont have to. If the function fail to provide a valid (readable) file then an HTTP 404 will be sent. ``` // server side: class Controller { function harnessDownload($file) { if (file_exists('./my-secret-files/' . $file)) { return './my-secret-files/' . $file; } } function harnessServe($file) { return $this->harnessDownload($file); } } // client side: Download Awesome image: ``` /download and /dist are pretty much the same. /download will also add a Content-Disposition header. If you want download and dist to serve the same files, implement the 2 functions as shown in the example above. ### Health Score 15 — LowBetter than 3% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community7 Small or concentrated contributor base Maturity25 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://avatars.githubusercontent.com/u/4835885?v=4)[Joshua Angnoe](/maintainers/j-angnoe)[@j-angnoe](https://github.com/j-angnoe) --- Top Contributors [![j-angnoe](https://avatars.githubusercontent.com/u/4835885?v=4)](https://github.com/j-angnoe "j-angnoe (7 commits)") ### Embed Badge ![Health badge](/badges/j-angnoe-harness/health.svg) ``` [![Health](https://phpackages.com/badges/j-angnoe-harness/health.svg)](https://phpackages.com/packages/j-angnoe-harness) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)