lists-manage's Introduction

@jnv/lists-manage

CLI program to manage lists project.

Usage
Commands

Usage

You must have Node.js 10+ and npm installed.

Then inside the cloned repository of lists project (where the README.md file is located) run:

$ npx @jnv/lists-manage add -w https://github.com/link-to/awesome-list

This will run this package and prompt you about the list you are about to add.

See Commands below for additional options and features.

Commands

lists-manage add URL
lists-manage fix
lists-manage help [COMMAND]
lists-manage sort

`lists-manage add URL`

Add list URL to the Markdown file

USAGE
  $ lists-manage add URL

ARGUMENTS
  URL  URL of the list to add (in form of https://github.com/user/repo)

OPTIONS
  -f, --file=file    [default: README.md] Markdown file to work with
  -h, --help         show CLI help
  -p, --[no-]prompt  Enable or disable interactive prompt; enabled by default, disabled when output is being redirected
  -w, --write        Edit [file] in place

EXAMPLE
  $ lists-manage add -w https://github.com/some-user/awesome-list

See code: src/commands/add.ts

`lists-manage fix`

Fix removed and redirected links

USAGE
  $ lists-manage fix

OPTIONS
  -f, --file=file  [default: README.md] Markdown file to work with
  -h, --help       show CLI help
  -w, --write      Edit [file] in place

EXAMPLES
  $ lists-manage fix -w
  $ lists-manage fix -f MY_LISTS_FILE.md

See code: src/commands/fix.ts

`lists-manage help [COMMAND]`

display help for lists-manage

USAGE
  $ lists-manage help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`lists-manage sort`

Just sort the items in file

USAGE
  $ lists-manage sort

OPTIONS
  -f, --file=file  [default: README.md] Markdown file to work with
  -h, --help       show CLI help
  -w, --write      Edit [file] in place

EXAMPLES
  $ lists-manage sort -w
  $ lists-manage sort -f MY_LISTS_FILE.md

See code: src/commands/sort.ts