xamfy / tpq

A task priority queue CLI to save your tasks and URLs that you want to visit later. Available on npm. Currently, Work in progress.
MIT License
3 stars 0 forks source link

tpq

A task priority queue CLI to save your tasks and URLs to visit later.

oclif Version Codecov Downloads/week License

Installation

Install tpq globally using npm. Use sudo if you don't use node with nvm.

$ npm install -g tpq

Usage

$ npm install -g tpq
$ tpq COMMAND
running command...
$ tpq (-v|--version|version)
tpq/1.0.1 linux-x64 node-v14.7.0
$ tpq --help [COMMAND]
USAGE
  $ tpq COMMAND
...

Commands

tpq add [FILE]

describe the command here

USAGE
  $ tpq add [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/add.ts

tpq autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ tpq autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ tpq autocomplete
  $ tpq autocomplete bash
  $ tpq autocomplete zsh
  $ tpq autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

tpq clear [FILE]

describe the command here

USAGE
  $ tpq clear [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/clear.ts

tpq commands

list all the commands

USAGE
  $ tpq commands

OPTIONS
  -h, --help              show CLI help
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

tpq hello [FILE]

describe the command here

USAGE
  $ tpq hello [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLE
  $ tpq hello
  hello world from ./src/hello.ts!

See code: src/commands/hello.ts

tpq help [COMMAND]

display help for tpq

USAGE
  $ tpq help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

tpq list [FILE]

describe the command here

USAGE
  $ tpq list [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/list.ts

tpq poll [FILE]

describe the command here

USAGE
  $ tpq poll [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/poll.ts

tpq random [FILE]

describe the command here

USAGE
  $ tpq random [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/random.ts

tpq autocomplete [SHELL]

Add tqp autocomplete in your shell(bash or zsh)

USAGE
  $ tpq autocomplete bash         setup autocomplete
  $ tpq autocomplete:script bash

tpq commands

Show all commands

Development

Setup dev environment using Docker

docker pull xamfy/tpq-dev:latest