Page MenuHomeMusing Studio
Files F10433494

README.md
No OneTemporary
Actions

README.md
View Options

writeas-cli
===========
![MIT license](https://img.shields.io/github/license/writeas/writeas-cli.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/writeas/writeas-cli)](https://goreportcard.com/report/github.com/writeas/writeas-cli) [![#writeas on freenode](https://img.shields.io/badge/freenode-%23writeas-blue.svg)](http://webchat.freenode.net/?channels=writeas) [![Public Slack discussion](http://slack.write.as/badge.svg)](http://slack.write.as/)
Command line interface for [Write.as](https://write.as) and [Write.as on Tor](http://writeas7pm7rcdqg.onion/). Works on Windows, OS X, and Linux.
Like the [Android app](https://play.google.com/store/apps/details?id=com.abunchtell.writeas), the command line client keeps track of the posts you make, so future editing / deleting is easier than [doing it with cURL](http://cmd.write.as/). 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](https://img.shields.io/github/release/writeas/writeas-cli.svg)](https://github.com/writeas/writeas-cli/releases/latest) ![Total downloads](https://img.shields.io/github/downloads/writeas/writeas-cli/total.svg)
Get the latest version for your operating system as a standalone executable.
**Windows**<br />
Download the [64-bit](https://github.com/writeas/writeas-cli/releases/download/v1.0/writeas_1.0_windows_amd64.zip) or [32-bit](https://github.com/writeas/writeas-cli/releases/download/v1.0/writeas_1.0_windows_386.zip) executable and put it somewhere in your `%PATH%`.
**macOS**<br />
Download the [64-bit](https://github.com/writeas/writeas-cli/releases/download/v1.0/writeas_1.0_darwin_amd64.zip) executable and put it somewhere in your `$PATH`, like `/usr/local/bin`.
**Linux**<br />
Download the [64-bit](https://github.com/writeas/writeas-cli/releases/download/v1.0/writeas_1.0_linux_amd64.tar.gz) or [32-bit](https://github.com/writeas/writeas-cli/releases/download/v1.0/writeas_1.0_linux_386.tar.gz) executable and put it somewhere in your `$PATH`, like `/usr/local/bin`.
### Go get it
```bash
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.
```bash
go get -u github.com/writeas/writeas-cli/cmd/writeas
```
## Usage
See full usage documentation on our [User Guide](GUIDE.md).
```
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](CONTRIBUTING.md).
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](https://write.as/contact), and prefer the #development channel [in Slack](http://slack.write.as) 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](https://write.as/contact) in one way or another. Be sure to provide the version of the CLI (with `writeas --version`) in your report.

File Metadata

Mime Type
text/plain
Expires
Mon, Jan 20, 4:01 AM (1 d, 20 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3135672

Event Timeline

musing studio · developers