# neocities-publish

> A CLI tool for publishing a site to Neocities

Latest version **1.0.10** (published 2024-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install neocities-publish
pnpm add neocities-publish
yarn add neocities-publish
bun add neocities-publish
```

Provides the commands `ncp`, `neocities-publish`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2024-08-29 |
| First published | 2024-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 29.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mastriel |
| Maintainers | mastriel |

## Links

- npm: https://www.npmjs.com/package/neocities-publish
- npm.io page: https://npm.io/package/neocities-publish

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [@inquirer/prompts](https://npm.io/package/@inquirer/prompts.md) ^5.3.8
- [@gerhobbelt/gitignore-parser](https://npm.io/package/@gerhobbelt/gitignore-parser.md) ^0.2.0-9

## Recent versions

- 1.0.10 (latest) — 2024-08-29
- 1.0.9 — 2024-08-28
- 1.0.8 — 2024-08-28
- 1.0.7 — 2024-08-28
- 1.0.6 — 2024-08-28
- 1.0.5 — 2024-08-28
- 1.0.4 — 2024-08-28
- 1.0.3 — 2024-08-28
- 1.0.2 — 2024-08-28
- 1.0.1 — 2024-08-28
- 1.0.0 — 2024-08-28

## README

# Neocities Publish

A small CLI tool to publish a directory to Neocities.

## Installation

```bash
npm i neocities-publish --global
```

## Usage
This will prompt you for your Neocities username and password, and then publish the contents of the current directory to Neocities.
```bash
npx ncp
```

## .ncignore
You can create a `.ncignore` file in the root of your project to specify files and directories to ignore when publishing to Neocities. This file uses the same syntax as `.gitignore`.

A .ncignore file will never be published to Neocities when using this tool.

### Example

```gitignore
# Ignore all files in the 'secret' folder
/secret/

# Ignore 'secret.txt' in any directory
secret.txt

# Ignore any .webp file in the 'static' directory.
/static/*.webp
```

---
_Source: https://npm.io/package/neocities-publish · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._