Command line client for Write.as

Matt Baer dc1ab5b9ea Move Contributing guidelines to .github dir 5 months ago
.github dc1ab5b9ea Move Contributing guidelines to .github dir 5 months ago
cmd 8d4e0ec138 Correctly name fileutils package 5 months ago
fileutils 8d4e0ec138 Correctly name fileutils package 5 months ago
.gitignore d22c844030 :rocket: 3 years ago
.travis.yml d22c844030 :rocket: 3 years ago
CHANGELOG.md 8b603378e7 Add release date to v1.0 5 months ago
GUIDE.md 405f555037 Update user guide with current logging / copy changes 5 months ago
LICENSE 2e6b502137 Add MIT license 2 years ago
README.md dc1ab5b9ea Move Contributing guidelines to .github dir 5 months ago

README.md

writeas-cli

MIT license Go Report Card Public Slack discussion

Command line interface for Write.as and Write.as on Tor. Works on Windows, OS X, and Linux.

Like the Android app, the command line client keeps track of the posts you make, so future editing / deleting is easier than doing it with cURL. The goal is for this to serve as the backend for any future GUI app we build for the desktop.

Installing

The easiest way to get the CLI is to download a pre-built executable for your OS.

Download

Latest release Total downloads

Get the latest version for your operating system as a standalone executable.

Windows
Download the 64-bit or 32-bit executable and put it somewhere in your %PATH%.

macOS
Download the 64-bit executable and put it somewhere in your $PATH, like /usr/local/bin.

Linux
Download the 64-bit or 32-bit executable and put it somewhere in your $PATH, like /usr/local/bin.

Go get it

go get github.com/writeas/writeas-cli/cmd/writeas

Once this finishes, you'll see writeas or writeas.exe inside $GOPATH/bin/.

Upgrading

To upgrade the CLI, download and replace the executable you downloaded before.

If you previously installed with go get, run it again with the -u option.

go get -u github.com/writeas/writeas-cli/cmd/writeas

Usage

See full usage documentation on our User Guide.

writeas [global options] command [command options] [arguments...]

COMMANDS:
   post     Alias for default action: create post from stdin
   new      Compose a new post from the command-line and publish
   delete   Delete a post
   update   Update (overwrite) a post
   get      Read a raw post
   add      Add an existing post locally
   list     List local posts
   help, h  Shows a list of commands or help for one command
   
GLOBAL OPTIONS:
   --tor, -t		 Perform action on Tor hidden service
   --tor-port "9150" Use a different port to connect to Tor
   --code            Specifies this post is code
   --verbose, -v     Make the operation more talkative
   --font value      Sets post font to given value (default: "mono")
   --help, -h		 show help
   --version, -v	 print the version

Contributing to the CLI

For a complete guide to contributing, see the Contribution Guide.

We welcome any kind of contributions including documentation, organizational improvements, tutorials, bug reports, feature requests, new features, answering questions, etc.

Getting Support

We're available on several channels, and prefer the #development channel in Slack for project discussion. Please don't use the GitHub issue tracker to ask questions.

Reporting Issues

If you believe you have found a bug in the CLI or its documentation, file an issue on this repo. If you're not sure if it's a bug or not, reach out to us in one way or another. Be sure to provide the version of the CLI (with writeas --version) in your report.