Page MenuHomeMusing Studio
Files F10387435

No OneTemporary
Actions

View Options

diff --git a/GUIDE.md b/GUIDE.md
index 864ae45..422cb00 100644
--- a/GUIDE.md
+++ b/GUIDE.md
@@ -1,143 +1,147 @@
# Write.as CLI User Guide
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".
## 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).
### Overview
```
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
publish Publish a file to Write.as
delete Delete a post
update Update (overwrite) a post
get Read a raw post
add Add an existing post locally
posts List all of your posts
claim Claim local unsynced posts
blogs List blogs
auth Authenticate with Write.as
logout Log out of Write.as
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
--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/aaaazzzzzzzza
```
This is generally more useful for posting terminal output or code, like so (the `--code` flag turns on syntax highlighting):
macOS / Linux: `cat writeas/cli.go | writeas --code`
Windows: `type writeas/cli.go | writeas.exe --code`
#### Output a post
This outputs any Write.as post with the given ID.
```bash
$ writeas get aaaazzzzzzzza
Hello world!
```
#### Authenticate
This will authenticate with write.as and store the user access token locally, until you explicitly logout.
```bash
$ writeas auth username
Password: ************
```
#### List all blogs
This will output a list of the authenticated user's blogs.
```bash
$ writeas blogs
Alias Title
user An Example Blog
dev My Dev Log
```
-#### List all published posts
+#### List posts
-This lists all posts you've published from your device, as well as any published by the authenticated user.
+This lists all posts you've published from your device
Pass the `--url` flag to show the list with full post URLs, and the `--md` flag to return URLs with Markdown enabled.
+To see post IDs with their Edit Tokens pass the `--v` flag.
+
```bash
$ writeas posts
-Local ID Token
-unsynced aaaazzzzzzzza dhuieoj23894jhf984hdfs9834hdf84j
+aaaazzzzzzzza
+
+$ writeas posts -url
+https://write.as/aaaazzzzzzzza
-Account ID Title
-synced mmmmmmmm33333333 This is a post
+$ writeas posts -v
+aaaazzzzzzzza | dhuieoj23894jhf984hdfs9834hdf84j
```
#### Delete a post
This permanently deletes a post you own.
```bash
$ writeas delete aaaazzzzzzzza
```
#### Update a post
This completely overwrites an existing post you own.
```bash
$ echo "See you later!" | writeas update aaaazzzzzzzza
```
#### Claim a post
This moves an unsynced local post to a draft on your account. You will need to authenticate first.
```bash
$ writeas claim aaaazzzzzzzza
```
### 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`
If you're publishing Markdown, supply the `--md` flag to get a URL back that will render Markdown, e.g.: `writeas new --font sans --md`
diff --git a/cmd/writeas/main.go b/cmd/writeas/main.go
index c113d19..06d8af5 100644
--- a/cmd/writeas/main.go
+++ b/cmd/writeas/main.go
@@ -1,265 +1,269 @@
package main
import (
"os"
"github.com/writeas/writeas-cli/commands"
"github.com/writeas/writeas-cli/config"
"github.com/writeas/writeas-cli/log"
cli "gopkg.in/urfave/cli.v1"
)
func main() {
initialize(appInfo["configDir"])
cli.VersionFlag = cli.BoolFlag{
Name: "version, V",
Usage: "print the version",
}
// Run the app
app := cli.NewApp()
app.Name = "writeas"
app.Version = config.Version
app.Usage = "Publish text quickly"
app.Authors = []cli.Author{
{
Name: "Write.as",
Email: "hello@write.as",
},
}
app.ExtraInfo = func() map[string]string {
return appInfo
}
app.Action = commands.CmdPost
app.Flags = config.PostFlags
app.Commands = []cli.Command{
{
Name: "post",
Usage: "Alias for default action: create post from stdin",
Action: commands.CmdPost,
Flags: config.PostFlags,
Description: `Create a new post on Write.as from stdin.
Use the --code flag to indicate that the post should use syntax
highlighting. Or use the --font [value] argument to set the post's
appearance, where [value] is mono, monospace (default), wrap (monospace
font with word wrapping), serif, or sans.`,
},
{
Name: "new",
Usage: "Compose a new post from the command-line and publish",
Description: `An alternative to piping data to the program.
On Windows, this will use 'copy con' to start reading what you input from the
prompt. Press F6 or Ctrl-Z then Enter to end input.
On *nix, this will use the best available text editor, starting with the
value set to the WRITEAS_EDITOR or EDITOR environment variable, or vim, or
finally nano.
Use the --code flag to indicate that the post should use syntax
highlighting. Or use the --font [value] argument to set the post's
appearance, where [value] is mono, monospace (default), wrap (monospace
font with word wrapping), serif, or sans.
If posting fails for any reason, 'writeas' will show you the temporary file
location and how to pipe it to 'writeas' to retry.`,
Action: commands.CmdNew,
Flags: config.PostFlags,
},
{
Name: "publish",
Usage: "Publish a file to Write.as",
Action: commands.CmdPublish,
Flags: config.PostFlags,
},
{
Name: "delete",
Usage: "Delete a post",
Action: commands.CmdDelete,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "tor, t",
Usage: "Delete via Tor hidden service",
},
cli.IntFlag{
Name: "tor-port",
Usage: "Use a different port to connect to Tor",
Value: 9150,
},
cli.BoolFlag{
Name: "verbose, v",
Usage: "Make the operation more talkative",
},
},
},
{
Name: "update",
Usage: "Update (overwrite) a post",
Action: commands.CmdUpdate,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "tor, t",
Usage: "Update via Tor hidden service",
},
cli.IntFlag{
Name: "tor-port",
Usage: "Use a different port to connect to Tor",
Value: 9150,
},
cli.BoolFlag{
Name: "code",
Usage: "Specifies this post is code",
},
cli.StringFlag{
Name: "font",
Usage: "Sets post font to given value",
},
cli.BoolFlag{
Name: "verbose, v",
Usage: "Make the operation more talkative",
},
},
},
{
Name: "get",
Usage: "Read a raw post",
Action: commands.CmdGet,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "tor, t",
Usage: "Get from Tor hidden service",
},
cli.IntFlag{
Name: "tor-port",
Usage: "Use a different port to connect to Tor",
Value: 9150,
},
cli.BoolFlag{
Name: "verbose, v",
Usage: "Make the operation more talkative",
},
},
},
{
Name: "add",
Usage: "Add an existing post locally",
Description: `A way to add an existing post to your local store for easy editing later.
This requires a post ID (from https://write.as/[ID]) and an Edit Token
(exported from another Write.as client, such as the Android app).
`,
Action: commands.CmdAdd,
},
{
Name: "posts",
Usage: "List all of your posts",
- Description: "This will list only local posts when not currently authenticated. To list remote posts as well, first run: writeas auth <username>.",
+ Description: "This will list only local posts.",
Action: commands.CmdListPosts,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "id",
Usage: "Show list with post IDs (default)",
},
cli.BoolFlag{
Name: "md",
Usage: "Use with --url to return URLs with Markdown enabled",
},
cli.BoolFlag{
Name: "url",
Usage: "Show list with URLs",
},
+ cli.BoolFlag{
+ Name: "verbose, v",
+ Usage: "Show verbose post listing, including Edit Tokens",
+ },
},
}, {
Name: "blogs",
Usage: "List blogs",
Action: commands.CmdCollections,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "url",
Usage: "Show list with URLs",
},
},
}, {
Name: "claim",
Usage: "Claim local unsynced posts",
Action: commands.CmdClaim,
Description: "This will claim any unsynced posts local to this machine. To see which posts these are run: writeas posts.",
Flags: []cli.Flag{
cli.BoolFlag{
Name: "verbose, v",
Usage: "Make the operation more talkative",
},
},
},
{
Name: "auth",
Usage: "Authenticate with Write.as",
Action: commands.CmdAuth,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "tor, t",
Usage: "Authenticate via Tor hidden service",
},
cli.IntFlag{
Name: "tor-port",
Usage: "Use a different port to connect to Tor",
Value: 9150,
},
cli.BoolFlag{
Name: "verbose, v",
Usage: "Make the operation more talkative",
},
},
},
{
Name: "logout",
Usage: "Log out of Write.as",
Action: commands.CmdLogOut,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "tor, t",
Usage: "Authenticate via Tor hidden service",
},
cli.IntFlag{
Name: "tor-port",
Usage: "Use a different port to connect to Tor",
Value: 9150,
},
cli.BoolFlag{
Name: "verbose, v",
Usage: "Make the operation more talkative",
},
},
},
}
cli.CommandHelpTemplate = `NAME:
{{.Name}} - {{.Usage}}
USAGE:
writeas {{.Name}}{{if .Flags}} [command options]{{end}} [arguments...]{{if .Description}}
DESCRIPTION:
{{.Description}}{{end}}{{if .Flags}}
OPTIONS:
{{range .Flags}}{{.}}
{{end}}{{ end }}
`
app.Run(os.Args)
}
func initialize(dataDirName string) {
// Ensure we have a data directory to use
if !config.DataDirExists(dataDirName) {
err := config.CreateDataDir(dataDirName)
if err != nil {
if config.Debug() {
panic(err)
} else {
log.Errorln("Error creating data directory: %s", err)
return
}
}
}
}
diff --git a/commands/commands.go b/commands/commands.go
index 0a4ba6a..e44b419 100644
--- a/commands/commands.go
+++ b/commands/commands.go
@@ -1,339 +1,305 @@
package commands
import (
"fmt"
"io/ioutil"
"os"
"text/tabwriter"
"github.com/howeyc/gopass"
"github.com/writeas/writeas-cli/api"
"github.com/writeas/writeas-cli/config"
"github.com/writeas/writeas-cli/log"
cli "gopkg.in/urfave/cli.v1"
)
func CmdPost(c *cli.Context) error {
_, err := api.HandlePost(api.ReadStdIn(), c)
return err
}
func CmdNew(c *cli.Context) error {
fname, p := api.ComposeNewPost()
if p == nil {
// Assume composeNewPost already told us what the error was. Abort now.
os.Exit(1)
}
// Ensure we have something to post
if len(*p) == 0 {
// Clean up temporary post
if fname != "" {
os.Remove(fname)
}
log.InfolnQuit("Empty post. Bye!")
}
_, err := api.HandlePost(*p, c)
if err != nil {
log.Errorln("Error posting: %s\n%s", err, config.MessageRetryCompose(fname))
return cli.NewExitError("", 1)
}
// Clean up temporary post
if fname != "" {
os.Remove(fname)
}
return nil
}
func CmdPublish(c *cli.Context) error {
filename := c.Args().Get(0)
if filename == "" {
return cli.NewExitError("usage: writeas publish <filename>", 1)
}
content, err := ioutil.ReadFile(filename)
if err != nil {
return err
}
_, err = api.HandlePost(content, c)
// TODO: write local file if directory is set
return err
}
func CmdDelete(c *cli.Context) error {
friendlyID := c.Args().Get(0)
token := c.Args().Get(1)
if friendlyID == "" {
return cli.NewExitError("usage: writeas delete <postId> [<token>]", 1)
}
u, _ := config.LoadUser(config.UserDataDir(c.App.ExtraInfo()["configDir"]))
if token == "" {
// Search for the token locally
token = api.TokenFromID(c, friendlyID)
if token == "" && u == nil {
log.Errorln("Couldn't find an edit token locally. Did you create this post here?")
log.ErrorlnQuit("If you have an edit token, use: writeas delete %s <token>", friendlyID)
}
}
tor := config.IsTor(c)
if c.Int("tor-port") != 0 {
api.TorPort = c.Int("tor-port")
}
if tor {
log.Info(c, "Deleting via hidden service...")
} else {
log.Info(c, "Deleting...")
}
err := api.DoDelete(c, friendlyID, token, tor)
if err != nil {
return cli.NewExitError(fmt.Sprintf("Couldn't delete remote copy: %v", err), 1)
}
// TODO: Delete local file, if necessary
return nil
}
func CmdUpdate(c *cli.Context) error {
friendlyID := c.Args().Get(0)
token := c.Args().Get(1)
if friendlyID == "" {
return cli.NewExitError("usage: writeas update <postId> [<token>]", 1)
}
u, _ := config.LoadUser(config.UserDataDir(c.App.ExtraInfo()["configDir"]))
if token == "" {
// Search for the token locally
token = api.TokenFromID(c, friendlyID)
if token == "" && u == nil {
log.Errorln("Couldn't find an edit token locally. Did you create this post here?")
log.ErrorlnQuit("If you have an edit token, use: writeas update %s <token>", friendlyID)
}
}
// Read post body
fullPost := api.ReadStdIn()
tor := config.IsTor(c)
if c.Int("tor-port") != 0 {
api.TorPort = c.Int("tor-port")
}
if tor {
log.Info(c, "Updating via hidden service...")
} else {
log.Info(c, "Updating...")
}
return api.DoUpdate(c, fullPost, friendlyID, token, c.String("font"), tor, c.Bool("code"))
}
func CmdGet(c *cli.Context) error {
friendlyID := c.Args().Get(0)
if friendlyID == "" {
return cli.NewExitError("usage: writeas get <postId>", 1)
}
tor := config.IsTor(c)
if c.Int("tor-port") != 0 {
api.TorPort = c.Int("tor-port")
}
if tor {
log.Info(c, "Getting via hidden service...")
} else {
log.Info(c, "Getting...")
}
return api.DoFetch(friendlyID, config.UserAgent(c), tor)
}
func CmdAdd(c *cli.Context) error {
friendlyID := c.Args().Get(0)
token := c.Args().Get(1)
if friendlyID == "" || token == "" {
return cli.NewExitError("usage: writeas add <postId> <token>", 1)
}
err := api.AddPost(c, friendlyID, token)
return err
}
func CmdListPosts(c *cli.Context) error {
urls := c.Bool("url")
ids := c.Bool("id")
+ details := c.Bool("v")
- var p api.Post
posts := api.GetPosts(c)
- tw := tabwriter.NewWriter(os.Stdout, 10, 0, 2, ' ', tabwriter.TabIndent)
- numPosts := len(*posts)
- if ids || !urls && numPosts != 0 {
- fmt.Fprintf(tw, "Local\t%s\t%s\t\n", "ID", "Token")
- } else if numPosts != 0 {
- fmt.Fprintf(tw, "Local\t%s\t%s\t\n", "URL", "Token")
- } else {
- fmt.Fprintf(tw, "No local posts found\n")
- }
- for i := range *posts {
- p = (*posts)[numPosts-1-i]
- if ids || !urls {
- fmt.Fprintf(tw, "unsynced\t%s\t%s\t\n", p.ID, p.EditToken)
+ for _, p := range *posts {
+ if details {
+ fmt.Printf("%s | %s\n", p.ID, p.EditToken)
+ } else if ids || !urls {
+ fmt.Printf("%s\n", p.ID)
} else {
- fmt.Fprintf(tw, "unsynced\t%s\t%s\t\n", getPostURL(c, p.ID), p.EditToken)
+ fmt.Printf("%s\n", getPostURL(c, p.ID))
}
}
- u, _ := config.LoadUser(config.UserDataDir(c.App.ExtraInfo()["configDir"]))
- if u != nil {
- remotePosts, err := api.GetUserPosts(c)
- if err != nil {
- fmt.Println(err)
- }
-
- if len(remotePosts) > 0 {
- identifier := "URL"
- if ids || !urls {
- identifier = "ID"
- }
- fmt.Fprintf(tw, "\nAccount\t%s\t%s\t\n", identifier, "Title")
- }
- for _, p := range remotePosts {
- identifier := getPostURL(c, p.ID)
- if ids || !urls {
- identifier = p.ID
- }
- synced := "unsynced"
- if p.Synced {
- synced = "synced"
- }
- fmt.Fprintf(tw, "%s\t%s\t%s\t\n", synced, identifier, p.Title)
- }
- }
- return tw.Flush()
+ return nil
}
func getPostURL(c *cli.Context, slug string) string {
base := config.WriteasBaseURL
if config.IsDev() {
base = config.DevBaseURL
}
ext := ""
// Output URL in requested format
if c.Bool("md") {
ext = ".md"
}
return fmt.Sprintf("%s/%s%s", base, slug, ext)
}
func CmdCollections(c *cli.Context) error {
u, err := config.LoadUser(config.UserDataDir(c.App.ExtraInfo()["configDir"]))
if err != nil {
return cli.NewExitError(fmt.Sprintf("couldn't load config: %v", err), 1)
}
if u == nil {
return cli.NewExitError("You must be authenticated to view collections.\nLog in first with: writeas auth <username>", 1)
}
colls, err := api.DoFetchCollections(c)
if err != nil {
return cli.NewExitError(fmt.Sprintf("Couldn't get collections for user %s: %v", u.User.Username, err), 1)
}
urls := c.Bool("url")
tw := tabwriter.NewWriter(os.Stdout, 8, 0, 2, ' ', tabwriter.TabIndent)
detail := "Title"
if urls {
detail = "URL"
}
fmt.Fprintf(tw, "%s\t%s\t\n", "Alias", detail)
for _, c := range colls {
dData := c.Title
if urls {
dData = c.URL
}
fmt.Fprintf(tw, "%s\t%s\t\n", c.Alias, dData)
}
tw.Flush()
return nil
}
func CmdClaim(c *cli.Context) error {
u, err := config.LoadUser(config.UserDataDir(c.App.ExtraInfo()["configDir"]))
if err != nil {
return cli.NewExitError(fmt.Sprintf("couldn't load config: %v", err), 1)
}
if u == nil {
return cli.NewExitError("You must be authenticated to claim local posts.\nLog in first with: writeas auth <username>", 1)
}
localPosts := api.GetPosts(c)
if len(*localPosts) == 0 {
return nil
}
log.Info(c, "Claiming %d post(s) for %s...", len(*localPosts), u.User.Username)
results, err := api.ClaimPosts(c, localPosts)
if err != nil {
return cli.NewExitError(fmt.Sprintf("Failed to claim posts: %v", err), 1)
}
var okCount, errCount int
for _, r := range *results {
id := r.ID
if id == "" {
// No top-level ID, so the claim was successful
id = r.Post.ID
}
status := fmt.Sprintf("Post %s...", id)
if r.ErrorMessage != "" {
log.Errorln("%serror: %v", status, r.ErrorMessage)
errCount++
} else {
log.Info(c, "%sOK", status)
okCount++
// only delete local if successful
api.RemovePost(c.App.ExtraInfo()["configDir"], id)
}
}
log.Info(c, "%d claimed, %d failed", okCount, errCount)
return nil
}
func CmdAuth(c *cli.Context) error {
// Check configuration
u, err := config.LoadUser(config.UserDataDir(c.App.ExtraInfo()["configDir"]))
if err != nil {
return cli.NewExitError(fmt.Sprintf("couldn't load config: %v", err), 1)
}
if u != nil && u.AccessToken != "" {
return cli.NewExitError("You're already authenticated as "+u.User.Username+". Log out with: writeas logout", 1)
}
// Validate arguments and get password
username := c.Args().Get(0)
if username == "" {
return cli.NewExitError("usage: writeas auth <username>", 1)
}
fmt.Print("Password: ")
pass, err := gopass.GetPasswdMasked()
if err != nil {
return cli.NewExitError(fmt.Sprintf("error reading password: %v", err), 1)
}
// Validate password
if len(pass) == 0 {
return cli.NewExitError("Please enter your password.", 1)
}
err = api.DoLogIn(c, username, string(pass))
if err != nil {
return cli.NewExitError(fmt.Sprintf("error logging in: %v", err), 1)
}
return nil
}
func CmdLogOut(c *cli.Context) error {
return api.DoLogOut(c)
}

File Metadata

Mime Type
text/x-diff
Expires
Mon, Nov 25, 9:13 AM (1 d, 14 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3105583

Event Timeline

musing studio · developers