Reocities CLI
Deploy and manage your site from your terminal. Push a folder, done.
Get API Key
Push Folders
Upload a whole directory in one command.
Pull Back
Download your whole site to a local folder.
Smart Ignore
Skip files with .gitignore or .reocitiesignore.
Zero Config
Set an API key once, or pass it per command.
Install
The CLI is a Python package, so install it with pip (not npm):
pip install reocities-cli
This gives you a reocities command. Works on Linux, macOS, and Windows (Python 3.6+).
Authenticate
reocities login your_api_key
Your key is saved to ~/.reocities/config. Generate a key here.
Deploy
Point it at your site folder and push:
reocities push ./my-site
handy Use a key per command
You don't have to log in first. Any command can take a key for that run only, which is useful in scripts and CI:
# pass it inline
reocities --api-key your_api_key push ./my-site
# or from the environment
export REOCITIES_API_KEY=your_api_key
reocities push ./my-site
Order of precedence: the --api-key flag, then REOCITIES_API_KEY, then the saved config.
All commands
| Command | Description |
|---|
reocities login <key> | Save your API key |
reocities logout | Remove the saved key |
reocities push [dir] | Upload a whole directory |
reocities upload <files...> [--folder F] | Upload individual files |
reocities pull [dir] [--folder F] | Download your site to a local folder |
reocities list [--folder F] [--recursive] | List files on your site |
reocities cat <path> | Print a remote file |
reocities mkdir <name> [--parent P] | Create a folder |
reocities delete <paths...> | Delete files or folders |
reocities whoami | Show the active site and storage use |
reocities open | Open your site in a browser |
Useful flags: push --dry-run (preview without uploading), --no-overwrite (skip existing files), --base-url (self-hosted instances).
Ignore files
Drop a .gitignore or .reocitiesignore in your project. Same syntax as git:
# .reocitiesignore
node_modules/
.env
*.log
dist/assets/*.map