Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 3.33 KB

README.md

File metadata and controls

89 lines (62 loc) · 3.33 KB
Raw

A Neocities client written in Go

Upload files to you Neocities website from the comfort of your own terminal.

Build Status GoDoc License MIT

Installation

You can download precompiled binaries for OS X, Linux, Windows (32 bit) and Windows (64 bit)

Or, if you have Go installed:

go get -u github.com/peterhellberg/neocities

Usage

Cat!

First you need to set two environment variables:

export NEOCITIES_USER=<user>
export NEOCITIES_PASS=<pass>

Alternatively you can use the NEOCITIES_KEY variable.

Then you should be able to upload files to your website:

neocities upload foo.html bar.js folder/baz.jpg

You can also delete files:

neocities delete foo.html folder/baz.jpg

You get a list of available commands by default:

$ neocities
usage: neocities <command> [<args>]

Commands:
   upload    Upload files to Neocities
   delete    Delete files from Neocities
   info      Info about Neocities websites
   key       Neocities API key
   list      List files on Neocities
   version   Show neocities client version

Help for a specific command:
   help [command]

Donate

Support Neocities

NeoCities is funded by donations. If you’d like to contribute, you can help to pay for server costs using Bitcoin or PayPal.

License (MIT)

Copyright (c) 2014-2019 Peter Hellberg

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.