The Write.as Command-Line Interface (CLI) is a cross-platform tool for publishing text to [Write.as](https://write.as) and its other sites, like [Paste.as](https://paste.as). It is designed to be simple, scriptable, do one job (publishing) well, and work as you'd expect with other command-line tools.
Write.as is a text-publishing service that protects your privacy. There's no sign up required to publish, but if you do sign up, you can access posts across devices and compile collections of them in what most people would call a "blog".
**Note** accounts are not supported in CLI v1.0. They'll be available in [v2.0](https://github.com/writeas/writeas-cli/milestone/4).
## Uses
These are a few common uses for `writeas`. If you get stuck or want to know more, run `writeas [command] --help`. If you still have questions, [ask us](https://write.as/contact).
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
+ auth Authenticate with Write.as
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
+ --tor, -t Perform action on Tor hidden service
+ --tor-port value Use a different port to connect to Tor (default: 9150)
+ --code Specifies this post is code
+ --verbose, -v Make the operation more talkative
+ --font value Sets post font to given value (default: "mono")
+ --user-agent value Sets the User-Agent for API requests
+ --help, -h show help
+ --version, -V print the version
```
#### Share something
By default, `writeas` creates a post with a `monospace` typeface that doesn't word wrap (scrolls horizontally). It will return a single line with a URL, and automatically copy that URL to the clipboard:
```bash
$ echo "Hello world!" | writeas
https://write.as/aaaaaaaaaaaa
```
This is generally more useful for posting terminal output or code, like so (the `--code` flag turns on syntax highlighting):
OS X / *nix: `cat writeas/cli.go | writeas --code`
This lists all posts you've published from your device. Pass the `--url` flag to show the list with full URLs.
```bash
$ writeas list
aaaaaaaaaaaa
```
#### Delete a post
This permanently deletes a post you own.
```bash
$ writeas delete aaaaaaaaaaaa
```
#### Update a post
This completely overwrites an existing post you own.
```bash
$ echo "See you later!" | writeas update aaaaaaaaaaaa
```
### Composing posts
If you simply have a penchant for never leaving your keyboard, `writeas` is great for composing new posts from the command-line. Just use the `new` subcommand.
`writeas new` will open your favorite command-line editor, as specified by your `WRITEAS_EDITOR` or `EDITOR` environment variables (in that order), falling back to `vim` on OS X / *nix.
Customize your post's appearance with the `--font` flag:
| Argument | Appearance (Typeface) | Word Wrap? |
| -------- | --------------------- | ---------- |
| `sans` | Sans-serif (Open Sans) | Yes |
| `serif` | Serif (Lora) | Yes |
| `wrap` | Monospace | Yes |
| `mono` | Monospace | No |
| `code` | Syntax-highlighted monospace | No |
Put it all together, e.g. publish with a sans-serif font: `writeas new --font sans`
Command line interface for [Write.as](https://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](http://writeas7pm7rcdqg.onion/)
* 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](https://play.google.com/store/apps/details?id=com.abunchtell.writeas)) for editing
## Installing
The easiest way to get the CLI is to download a pre-built executable for your OS.
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.1/writeas_1.1_windows_amd64.zip) or [32-bit](https://github.com/writeas/writeas-cli/releases/download/v1.1/writeas_1.1_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.1/writeas_1.1_darwin_amd64.tar.gz) 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.1/writeas_1.1_linux_amd64.tar.gz) or [32-bit](https://github.com/writeas/writeas-cli/releases/download/v1.1/writeas_1.1_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).
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
+ auth Authenticate with Write.as
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
+ --tor, -t Perform action on Tor hidden service
+ --tor-port value Use a different port to connect to Tor (default: 9150)
+ --code Specifies this post is code
+ --verbose, -v Make the operation more talkative
+ --font value Sets post font to given value (default: "mono")
+ --user-agent value Sets the User-Agent for API requests
+ --help, -h show help
+ --version, -V print the version
```
## Contributing to the CLI
For a complete guide to contributing, see the [Contribution Guide](.github/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.