PHPackages                             reed-jones/neocities - 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. [API Development](/categories/api)
4. /
5. reed-jones/neocities

ActiveLibrary[API Development](/categories/api)

reed-jones/neocities
====================

A thin client wrapper around the neocities api

v0.2.1(6y ago)19942[1 issues](https://github.com/reed-jones/Neocities-php/issues)[1 PRs](https://github.com/reed-jones/Neocities-php/pulls)1ISCPHPPHP >=7.1

Since Sep 8Pushed 2y ago3 watchersCompare

[ Source](https://github.com/reed-jones/Neocities-php)[ Packagist](https://packagist.org/packages/reed-jones/neocities)[ RSS](/packages/reed-jones-neocities/feed)WikiDiscussions master Synced yesterday

READMEChangelog (2)DependenciesVersions (4)Used By (1)

Neocities PHP Client Library
============================

[](#neocities-php-client-library)

Neocities-php is a PHP wrapper of the [Neocities.org](https://neocities.org/) API. Now with [Jigsaw](https://jigsaw.tighten.co/) integration

Installation
------------

[](#installation)

```
composer require reed-jones/neocities
```

Usage
-----

[](#usage)

```
// First we include the library
use ReedJones\Neocities\Neocities;

// Then we log in using either username/password or api key

$neocities = new Neocities([
    'username' => 'YOUR_USERNAME',
    'password' => 'YOUR_PASSWORD'
]);

// or

$neocities = new Neocities([
    'apiKey' => 'YOUR_API_KEY'
]);
```

### Uploading Files

[](#uploading-files)

To upload files pass an array with the key being the desired upload name on the server, and the value being the path to the local file.

```
$result = $neocities->upload([
    'hello.html' => './local.html',
    'about.html' => './AboutMe.html'
]);

var_dump($result);
```

### Deleting Files

[](#deleting-files)

To delete files from the server, simply pass an array of the files you wish to delete.

```
$result = $neocities->delete([
    'hello.html',
    'about.html'
]);

var_dump($result);
```

### Listing All Files On Your Site

[](#listing-all-files-on-your-site)

```
$result = $neocities->list();

var_dump($result);
```

### Getting Information About Your Site

[](#getting-information-about-your-site)

```
$result = $neocities->info();

var_dump($result);
```

### Getting Your API Key

[](#getting-your-api-key)

If you are logging in using your username/password, you can use this to retrieve your API key.

```
$result = $neocities->key();

var_dump($result);
```

Jigsaw Integration
------------------

[](#jigsaw-integration)

Neocities-PHP can be integrated with [Tighten's Jigsaw](https://jigsaw.tighten.co/). After installing this packing into your jigsaw project, Register the plugin in `bootstrap.php`

```
// bootstrap.php
Jigsaw::mixin(new \ReedJones\Neocities\NeocitiesDeployment($container));
```

With this in place, all that is left to do is add your neocities api key your your .env file (if id doesn't exist, create it)

```
# .env
NEO_CITIES_API_KEY="YOUR_API_KEY_HERE"
```

Now to build & deploy from the command line, run the new `jigsaw deploy` command which accepts the same parameters as the `build` command.

```
# Build & deploy your 'local' build
./vendor/bin/jigsaw deploy
```

```
# Build & deploy your 'production' build
./vendor/bin/jigsaw deploy production
```

### Jigsaw Programmatic Usage

[](#jigsaw-programmatic-usage)

After following the above instructions for setting up a neocities deployment with jigsaw, a `deployToNeocities` method is available for programmatic use from bootstrap.php (or elsewhere). An Example:

```
// Programmatic API Usage
$events->afterBuild(function (Jigsaw $jigsaw) {
    if ($jigsaw->getEnvironment() === 'production') {
        // Automatic deployment after all production builds
        $jigsaw->deployToNeocities();
    }
});
```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 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.

###  Release Activity

Cadence

Every ~260 days

Total

3

Last Release

2284d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/11511864?v=4)[Reed Jones](/maintainers/reed-jones)[@reed-jones](https://github.com/reed-jones)

---

Top Contributors

[![reed-jones](https://avatars.githubusercontent.com/u/11511864?v=4)](https://github.com/reed-jones "reed-jones (8 commits)")

---

Tags

apineocities

### Embed Badge

![Health badge](/badges/reed-jones-neocities/health.svg)

```
[![Health](https://phpackages.com/badges/reed-jones-neocities/health.svg)](https://phpackages.com/packages/reed-jones-neocities)
```

###  Alternatives

[m165437/laravel-blueprint-docs

API Blueprint Renderer for Laravel

22779.0k](/packages/m165437-laravel-blueprint-docs)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)