Quick Start

Deploy your static site to Neocities in under a minute.

1. Install

Install
gem install neocities-red

2. Authenticate

The first authenticated command prompts you for your Neocities sitename (or username) and password. The resulting API key is stored locally for future runs.

You can also skip the prompt entirely with an API key:

With an API key
export NEOCITIES_API_KEY="your-api-key"
neocities-red push .

Read more in the authentication guide.

3. Push your site

From your site's directory, upload the whole folder recursively:

Deploy
cd ~/my-neocities-site
neocities-red push .

push respects your .gitignore rules by default, uploads files in parallel (up to 5 workers) and retries transient API failures automatically.

Helpful first commands

  • neocities-red help — list every command
  • neocities-red help push — per-command help
  • neocities-red diff . — preview what would change before pushing
  • neocities-red push . --dry-run — show intended actions without uploading
  • neocities-red info — site stats