Command line utility for publishing to any WriteFreely instance. Works on Windows, macOS, and Linux.
The WriteFreely CLI is compatible with WriteFreely v0.11 or later.
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
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 wf-cli
**Linux (other)**
Download the 64-bit or 32-bit executable and put it somewhere in your $PATH
, like /usr/local/bin
.
go get github.com/writeas/writeas-cli/cmd/wf
Once this finishes, you’ll see wf
or wf.exe
inside $GOPATH/bin/
.
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/wf
See full usage documentation on our User Guide.
wf [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
publish Publish a file
delete Delete a post
update Update (overwrite) a post
get Read a raw post
posts List draft posts
blogs List blogs
accounts List all currently logged in accounts
auth Authenticate with a WriteFreely instance
logout Log out of a WriteFreely instance
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
-c value, -b value Optional blog to post to
--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
--md Returns post URL with Markdown enabled
--verbose, -v Make the operation more talkative
--font value Sets post font to given value (default: "mono")
--lang value Sets post language to given ISO 639-1 language code
--user-agent value Sets the User-Agent for API requests
--host value, -H value Operate against a custom hostname
--user value, -u value Use authenticated user, other than default
--help, -h show help
--version, -V print the version
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.
We’re available on several channels, and prefer our forum for project discussion. Please don’t use the GitHub issue tracker to ask questions.
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 wf --version
) in your report.