Frequently Asked Questions

Answers to common questions about deploying sites to Neocities with Neocities Red.

What is Neocities Red?

Neocities Red is a modern command-line client and Ruby library for Neocities — the free web hosting service. It is a refactored and extended fork of the official neocities-ruby gem, focused on performance, reliability and real-world static site workflows.

How do I deploy my static site to Neocities?

Install the gem, log in once, then push your site's folder:

gem install neocities-red
cd ~/my-site
neocities-red push .

That's it — files are uploaded recursively and in parallel. See the quick start for details.

Which Ruby versions are supported?

Ruby 3.4 and newer. The gem is CI-tested against Ruby 3.4, 3.5 and 4.0 on Linux, macOS, Windows and FreeBSD.

Is my site uploaded faster than with the official CLI?

Usually, yes. Neocities Red uploads files with up to 5 parallel workers, retries flaky API and SSL failures automatically, and the --optimized flag skips files whose SHA1 hash already matches the server.

Does push upload my .env or secret files?

No. push respects your .gitignore rules by default. Use --no-gitignore to disable filtering, or -e/--exclude to exclude specific paths.

Can I use Neocities Red with Jekyll, Hugo or Eleventy?

Yes — that's one of the main design goals. Build your site with any static site generator, then run neocities-red push _site (or your output directory) to deploy it.

Can I use Neocities Red in CI/CD?

Yes. Pass --api-key or set the NEOCITIES_API_KEY environment variable for non-interactive deploys. See the authentication guide.

How do I backup my Neocities site?

Run neocities-red pull — it downloads your files and skips anything unchanged since your last pull, so backups are fast.

What does the pizza command do?

It's a hidden easter egg. Order a free pizza — responsibility not included.

Is Neocities Red free and open source?

Yes. It is MIT-licensed, free to use, and contributions are welcome via the GitHub repository.