Skip to content

writefreely/writefreely-cli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

writeas-cli

MIT license Go Report Card #writeas on freenode Public Slack discussion

Command line interface for Write.as. Works on Windows, macOS, and Linux.

Features

  • Publish anonymously to Write.as
  • A stable, easy back-end for your GUI app or desktop-based workflow
  • Compatible with our Tor hidden service
  • Locally keeps track of any posts you make
  • Update and delete anonymous posts
  • Fetch any post by ID
  • Add anonymous post credentials (like for one published with the Android app) for editing

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.

Debian-based Linux

sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys DBE07445
sudo add-apt-repository "deb http://updates.writeas.org xenial main"
sudo apt-get update && sudo apt-get install writeas-cli

Linux (other)
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.

About

Command line client for Write.as

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%