🟥 Neocities Red

A modern Neocities CLI

A refactored and extended fork of the official https://github.com/neocities/neocities-ruby

Built for performance, reliability, and real-world workflows (especially static site generators).

• CLI with explicit command help (neocities-red help <command>)
• Parallel uploads (up to 5 concurrent workers)
• Smart diffing (only upload what changed)
• Automatic retries (handles flaky Neocities API / SSL issues)
• Recursive uploads out of the box
• SSG-friendly (Jekyll, Hugo, Eleventy, etc.)
• Namespaced services grouped by domain (file/, site/, common/)

• Ruby 3.4+ (tested, supports 4.x)

Not a programmer?

• Install Ruby here - https://www.ruby-lang.org/en/
• For Windows you should have installed MSYS2 and MINGW

gem install neocities-red

neocities-red help
neocities-red help push

push      Recursively upload a local directory to your site
upload    Upload individual files/folders to your site
delete    Delete remote files
diff      Compare local directory with remote
list      List remote files
info      Show site info
pull      Download latest remote files
logout    Remove stored API key from config
version   Print gem version
pizza     Easter egg

Examples:

neocities-red push .
neocities-red push . --optimized --ignore-dotfiles
neocities-red push . -e node_modules -e .git
neocities-red diff . -e secret.txt

require 'neocities-red'

client = NeocitiesRed::Client.new(api_key: 'YOUR_API_KEY')

client.upload(local_path, remote_path)
client.delete(remote_path)
client.list(remote_path)
client.info(sitename)

client = NeocitiesRed::Client.new(
  sitename: 'o200',
  password: 'secret'
)

service = NeocitiesRed::Services::File::List.new(
  client,
  '.',
  true
)

files = service.show

Current service namespaces:

• NeocitiesRed::Services::File (Uploader, FolderUploader, List, Remover)
• NeocitiesRed::Services::Site (Pusher, Differencer, Exporter, Informer)
• NeocitiesRed::Services::Common (Pizza)

see CONTRIBUTING.md

MIT — see LICENSE

Built for the Neocities community.