diff --git a/GUIDE.md b/GUIDE.md index a1fc1f0..87a2948 100644 --- a/GUIDE.md +++ b/GUIDE.md @@ -1,106 +1,110 @@ # 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". **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). ### 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 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 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` +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 aaaaaaaaaaaa Hello world! ``` #### List all published posts -This lists all posts you've published from your device. Pass the `--url` flag to show the list with full URLs. +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. ```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` + +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/api.go b/cmd/writeas/api.go index 66c3fe0..230b3c8 100644 --- a/cmd/writeas/api.go +++ b/cmd/writeas/api.go @@ -1,221 +1,225 @@ package main import ( "fmt" "github.com/atotto/clipboard" "github.com/writeas/web-core/posts" "github.com/writeas/writeas-cli/fileutils" "go.code.as/writeas.v2" "gopkg.in/urfave/cli.v1" "path/filepath" ) const ( defaultUserAgent = "writeas-cli v" + version ) func client(userAgent string, tor bool) *writeas.Client { var client *writeas.Client if tor { client = writeas.NewTorClient(torPort) } else { if isDev() { client = writeas.NewDevClient() } else { client = writeas.NewClient() } } client.UserAgent = userAgent return client } func newClient(c *cli.Context, authRequired bool) (*writeas.Client, error) { var client *writeas.Client if isTor(c) { client = writeas.NewTorClient(torPort) } else { if isDev() { client = writeas.NewDevClient() } else { client = writeas.NewClient() } } client.UserAgent = userAgent(c) // TODO: load user into var shared across the app u, _ := loadUser() if u != nil { client.SetToken(u.AccessToken) } else if authRequired { return nil, fmt.Errorf("Not currently logged in. Authenticate with: writeas auth ") } return client, nil } // DoFetch retrieves the Write.as post with the given friendlyID, // optionally via the Tor hidden service. func DoFetch(friendlyID, ua string, tor bool) error { cl := client(ua, tor) p, err := cl.GetPost(friendlyID) if err != nil { return err } if p.Title != "" { fmt.Printf("# %s\n\n", string(p.Title)) } fmt.Printf("%s\n", string(p.Content)) return nil } // DoPost creates a Write.as post, returning an error if it was // unsuccessful. func DoPost(c *cli.Context, post []byte, font string, encrypt, tor, code bool) (*writeas.Post, error) { cl, _ := newClient(c, false) pp := &writeas.PostParams{ Font: getFont(code, font), Collection: collection(c), } pp.Title, pp.Content = posts.ExtractTitle(string(post)) if lang := language(c, true); lang != "" { pp.Language = &lang } p, err := cl.CreatePost(pp) if err != nil { return nil, fmt.Errorf("Unable to post: %v", err) } var url string if p.Collection != nil { url = p.Collection.URL + p.Slug } else { if tor { url = torBaseURL } else if isDev() { url = devBaseURL } else { url = writeasBaseURL } url += "/" + p.ID + // Output URL in requested format + if c.Bool("md") { + url += ".md" + } } if cl.Token() == "" { // Store post locally, since we're not authenticated addPost(p.ID, p.Token) } // Copy URL to clipboard err = clipboard.WriteAll(string(url)) if err != nil { Errorln("writeas: Didn't copy to clipboard: %s", err) } else { Info(c, "Copied to clipboard.") } // Output URL fmt.Printf("%s\n", url) return p, nil } // DoUpdate updates the given post on Write.as. func DoUpdate(c *cli.Context, post []byte, friendlyID, token, font string, tor, code bool) error { cl, _ := newClient(c, false) params := writeas.PostParams{ ID: friendlyID, Token: token, } params.Title, params.Content = posts.ExtractTitle(string(post)) if lang := language(c, false); lang != "" { params.Language = &lang } if code || font != "" { params.Font = getFont(code, font) } _, err := cl.UpdatePost(¶ms) if err != nil { if debug { ErrorlnQuit("Problem updating: %v", err) } return fmt.Errorf("Post doesn't exist, or bad edit token given.") } if tor { Info(c, "Post updated via hidden service.") } else { Info(c, "Post updated.") } return nil } // DoDelete deletes the given post on Write.as. func DoDelete(c *cli.Context, friendlyID, token string, tor bool) error { cl, _ := newClient(c, false) err := cl.DeletePost(&writeas.PostParams{ ID: friendlyID, Token: token, }) if err != nil { if debug { ErrorlnQuit("Problem deleting: %v", err) } return fmt.Errorf("Post doesn't exist, or bad edit token given.") } if tor { Info(c, "Post deleted from hidden service.") } else { Info(c, "Post deleted.") } removePost(friendlyID) return nil } func DoLogIn(c *cli.Context, username, password string) error { cl := client(userAgent(c), isTor(c)) u, err := cl.LogIn(username, password) if err != nil { if debug { ErrorlnQuit("Problem logging in: %v", err) } return err } err = saveUser(u) if err != nil { return err } fmt.Printf("Logged in as %s.\n", u.User.Username) return nil } func DoLogOut(c *cli.Context) error { cl, err := newClient(c, true) if err != nil { return err } err = cl.LogOut() if err != nil { if debug { ErrorlnQuit("Problem logging out: %v", err) } return err } // Delete local user data err = fileutils.DeleteFile(filepath.Join(userDataDir(), userFile)) if err != nil { return err } return nil } diff --git a/cmd/writeas/cli.go b/cmd/writeas/cli.go index d399de5..84f1a9e 100644 --- a/cmd/writeas/cli.go +++ b/cmd/writeas/cli.go @@ -1,351 +1,359 @@ package main import ( "bufio" "go.code.as/writeas.v2" "gopkg.in/urfave/cli.v1" "io" "log" "os" ) // API constants for communicating with Write.as. const ( writeasBaseURL = "https://write.as" devBaseURL = "https://development.write.as" torBaseURL = "http://writeas7pm7rcdqg.onion" ) // Application constants. const ( - version = "1.2-dev" + version = "2.0-dev" ) // Defaults for posts on Write.as. const ( defaultFont = PostFontMono ) // Available flags for creating posts var postFlags = []cli.Flag{ cli.StringFlag{ Name: "c, b", Usage: "Optional blog to post to", Value: "", }, cli.BoolFlag{ Name: "tor, t", Usage: "Perform action on 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.BoolFlag{ + Name: "md", + Usage: "Returns post URL with Markdown enabled", + }, cli.BoolFlag{ Name: "verbose, v", Usage: "Make the operation more talkative", }, cli.StringFlag{ Name: "font", Usage: "Sets post font to given value", Value: defaultFont, }, cli.StringFlag{ Name: "lang", Usage: "Sets post language to given ISO 639-1 language code", Value: "", }, cli.StringFlag{ Name: "user-agent", Usage: "Sets the User-Agent for API requests", Value: "", }, } func main() { initialize() cli.VersionFlag = cli.BoolFlag{ Name: "version, V", Usage: "print the version", } // Run the app app := cli.NewApp() app.Name = "writeas" app.Version = version app.Usage = "Publish text quickly" app.Authors = []cli.Author{ { Name: "Write.as", Email: "hello@write.as", }, } app.Action = cmdPost app.Flags = postFlags app.Commands = []cli.Command{ { Name: "post", Usage: "Alias for default action: create post from stdin", Action: cmdPost, Flags: 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 WRITAS_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: cmdNew, Flags: postFlags, }, { - Name: "publish", - Usage: "Publish a file to Write.as", - Action: cmdPublish, - Flags: postFlags, + Name: "publish", + Usage: "Publish a file to Write.as", + Action: cmdPublish, + Flags: postFlags, }, { Name: "delete", Usage: "Delete a post", Action: 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: 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: 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: cmdAdd, }, { Name: "list", Usage: "List local posts", Action: cmdList, 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", }, }, }, { Name: "fetch", Usage: "Fetch authenticated user's Write.as posts", Action: cmdPull, 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: "auth", Usage: "Authenticate with Write.as", Action: 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: 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() { // Ensure we have a data directory to use if !dataDirExists() { createDataDir() } } func readStdIn() []byte { numBytes, numChunks := int64(0), int64(0) r := bufio.NewReader(os.Stdin) fullPost := []byte{} buf := make([]byte, 0, 1024) for { n, err := r.Read(buf[:cap(buf)]) buf = buf[:n] if n == 0 { if err == nil { continue } if err == io.EOF { break } log.Fatal(err) } numChunks++ numBytes += int64(len(buf)) fullPost = append(fullPost, buf...) if err != nil && err != io.EOF { log.Fatal(err) } } return fullPost } func handlePost(fullPost []byte, c *cli.Context) (*writeas.Post, error) { tor := isTor(c) if c.Int("tor-port") != 0 { torPort = c.Int("tor-port") } if tor { Info(c, "Posting to hidden service...") } else { Info(c, "Posting...") } return DoPost(c, fullPost, c.String("font"), false, tor, c.Bool("code")) } diff --git a/cmd/writeas/commands.go b/cmd/writeas/commands.go index a99fb1b..20e2b7c 100644 --- a/cmd/writeas/commands.go +++ b/cmd/writeas/commands.go @@ -1,237 +1,242 @@ package main import ( "fmt" "github.com/howeyc/gopass" "github.com/writeas/writeas-cli/fileutils" "gopkg.in/urfave/cli.v1" "io/ioutil" "os" "path/filepath" ) func cmdPost(c *cli.Context) error { _, err := handlePost(readStdIn(), c) return err } func cmdNew(c *cli.Context) error { fname, p := 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) } InfolnQuit("Empty post. Bye!") } _, err := handlePost(*p, c) if err != nil { Errorln("Error posting: %s", err) Errorln(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 ", 1) } content, err := ioutil.ReadFile(filename) if err != nil { return err } p, err := handlePost(content, c) if err != nil { return err } // Save post to posts folder cfg, err := loadConfig() if cfg.Posts.Directory != "" { err = WritePost(cfg.Posts.Directory, p) if err != nil { return err } } return nil } func cmdDelete(c *cli.Context) error { friendlyID := c.Args().Get(0) token := c.Args().Get(1) if friendlyID == "" { return cli.NewExitError("usage: writeas delete []", 1) } u, _ := loadUser() if token == "" { // Search for the token locally token = tokenFromID(friendlyID) if token == "" && u == nil { Errorln("Couldn't find an edit token locally. Did you create this post here?") ErrorlnQuit("If you have an edit token, use: writeas delete %s ", friendlyID) } } tor := isTor(c) if c.Int("tor-port") != 0 { torPort = c.Int("tor-port") } if tor { Info(c, "Deleting via hidden service...") } else { Info(c, "Deleting...") } err := DoDelete(c, friendlyID, token, tor) if err != nil { return err } // Delete local file, if necessary cfg, err := loadConfig() if cfg.Posts.Directory != "" { // TODO: handle deleting blog posts err = fileutils.DeleteFile(filepath.Join(cfg.Posts.Directory, friendlyID+postFileExt)) if err != nil { return err } } 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 []", 1) } u, _ := loadUser() if token == "" { // Search for the token locally token = tokenFromID(friendlyID) if token == "" && u == nil { Errorln("Couldn't find an edit token locally. Did you create this post here?") ErrorlnQuit("If you have an edit token, use: writeas update %s ", friendlyID) } } // Read post body fullPost := readStdIn() tor := isTor(c) if c.Int("tor-port") != 0 { torPort = c.Int("tor-port") } if tor { Info(c, "Updating via hidden service...") } else { Info(c, "Updating...") } return 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 ", 1) } tor := isTor(c) if c.Int("tor-port") != 0 { torPort = c.Int("tor-port") } if tor { Info(c, "Getting via hidden service...") } else { Info(c, "Getting...") } return DoFetch(friendlyID, 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 ", 1) } err := addPost(friendlyID, token) return err } func cmdList(c *cli.Context) error { urls := c.Bool("url") ids := c.Bool("id") var p Post posts := getPosts() for i := range *posts { p = (*posts)[len(*posts)-1-i] if ids || !urls { fmt.Printf("%s ", p.ID) } if urls { base := writeasBaseURL if isDev() { base = devBaseURL } - fmt.Printf("%s/%s ", base, p.ID) + ext := "" + // Output URL in requested format + if c.Bool("md") { + ext = ".md" + } + fmt.Printf("%s/%s%s ", base, p.ID, ext) } fmt.Print("\n") } return nil } func cmdAuth(c *cli.Context) error { // Check configuration u, err := loadUser() 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 ", 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) } return DoLogIn(c, username, string(pass)) } func cmdLogOut(c *cli.Context) error { return DoLogOut(c) } diff --git a/debian/changelog b/debian/changelog index 06d28d8..eeb47d5 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,9 +1,21 @@ +writeas-cli (1.2) xenial; urgency=medium + + * Add --md flag + + -- Write.as Sat, 29 Sep 2018 12:15:27 -0400 + +writeas-cli (1.1+git20171119.dc1ab5b-1ubuntu1) xenial; urgency=medium + + * Add --user-agent flag + + -- Write.as Tue, 25 Sep 2018 13:02:41 -0400 + writeas-cli (1.0+git20171119.dc1ab5b-1) xenial; urgency=medium * All logging and errors go to stderr, not stdout (Closes: #11) * Verbose logging requires `-v` or `--verbose` flag * Executable now lives in `cmd/` directory * All errors exit with status 1 * Fixed `cli` library deprecation (Closes: #8) -- Write.as Sun, 19 Nov 2017 09:36:28 -0500