Installation

Install Neocities Red in one command and start deploying static sites to Neocities.

Requirements

Neocities Red requires Ruby 3.4 or newer — CI-tested against 3.4, 3.5 and 4.0 on Linux, macOS, Windows and FreeBSD.

Not a programmer? Getting Ruby is easy:

  • Install Ruby from ruby-lang.org
  • On Windows, install MSYS2 and MINGW for the native build toolchain

Install the gem

Install
gem install neocities-red

Check that the CLI is available:

Verify
neocities-red version
# => neocities-red version 1.2.0

Build from source

Clone the repository and use the bundled bin script:

From source
git clone https://github.com/o-200/neocities-red.git
cd neocities-red
bundle install
bundle exec ruby bin/neocities-red help

Next steps