From 3db0c511fc875041f6c794a9c6677b5ded4ffc4d Mon Sep 17 00:00:00 2001 From: theimpostor Date: Thu, 3 Aug 2023 21:52:18 -0500 Subject: Update readme, arg num validation --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fb1b649..2e78455 100644 --- a/README.md +++ b/README.md @@ -3,32 +3,39 @@ A command line tool to access the system clipboard from anywhere on the command System clipboard access includes writing (i.e. copy) and reading (i.e. paste), even while logged into a remote machine via ssh. -## Usage +## Examples + ``` -Reads or writes the system clipboard using the ANSI OSC52 escape sequence. +❯ echo asdf | osc copy -Usage: +# String 'asdf' copied to clipboard -COPY mode (default): +❯ osc paste +asdf +``` + +## Usage - osc52 [file1 [...fileN]] +``` +Reads or writes the system clipboard using the ANSI OSC52 escape sequence. -With no arguments, will read from stdin. +Usage: + osc [command] -PASTE mode: +Available Commands: + completion Generate the autocompletion script for the specified shell + copy Copies input to the system clipboard + help Help about any command + paste Outputs system clipboard contents to stdout + version Outputs version information - osc52 --paste +Flags: + -h, --help help for osc + -l, --log string write logs to file + -v, --verbose verbose logging -Outputs clipboard contents to stdout. +Use "osc [command] --help" for more information about a command. -Options: - -logFile string - redirect logs to file - -paste - paste operation - -v verbose logging - -verbose - verbose logging ``` ## Compatibility @@ -59,17 +66,10 @@ Terminal Multiplexer | Copy | Paste | Notes ## Installation -#### go 1.16 or later: - ``` go install -v github.com/theimpostor/osc@latest ``` -#### go 1.15 or earlier: -``` -GO111MODULE=on go get github.com/theimpostor/osc@latest -``` - This will install the latest version of osc to `$GOPATH/bin`. To find out where `$GOPATH` is, run `go env GOPATH` ## TODO -- cgit v1.2.3