README.md

netvissoc

CLI network creation tool and graph visualization for social networks

• Usage
• Commands

Usage

$ npm install -g netvissoc
$ netvissoc COMMAND
running command...
$ netvissoc (-v|--version|version)
netvissoc/1.1.0 darwin-x64 node-v16.6.0
$ netvissoc --help [COMMAND]
USAGE
  $ netvissoc COMMAND
...

Commands

• netvissoc add NAME
• netvissoc check
• netvissoc delete NAME
• netvissoc graph
• netvissoc help [COMMAND]
• netvissoc link FROM TO TYPE
• netvissoc list
• netvissoc relink FROM TO OLD [NEW]
• netvissoc rename OLD NEW
• netvissoc unlink FROM TO TYPE

netvissoc add NAME

add a new node without connections

USAGE
  $ netvissoc add NAME

ARGUMENTS
  NAME  name(s) to be added, comma-separated

OPTIONS
  -h, --help           show CLI help
  -i, --input=input    [default: .] input directory
  -n, --notes=notes    optional notes
  -o, --output=output  [default: .] output directory

EXAMPLES
  $ netvissoc add -i ./test -o ./test "Adam Ewing" -n "An American lawyer from San Francisco"
  $ netvissoc add -i ./test -o ./test "Adam Ewing, Henry Goose"

See code: src/commands/add.ts

netvissoc check

check for and display potential problems with input files

USAGE
  $ netvissoc check

OPTIONS
  -h, --help         show CLI help
  -i, --input=input  [default: .] input directory

EXAMPLE
  $ netvissoc check -i ./test

See code: src/commands/check.ts

netvissoc delete NAME

remove all occurrences of name and delete corresponding file

USAGE
  $ netvissoc delete NAME

ARGUMENTS
  NAME  name(s) to be deleted, comma-separated

OPTIONS
  -h, --help           show CLI help
  -i, --input=input    [default: .] input directory
  -o, --output=output  [default: .] output directory

EXAMPLE
  $ netvissoc delete -i ./test -o ./test "Bill Smoke"

See code: src/commands/delete.ts

netvissoc graph

open network visualization tool

USAGE
  $ netvissoc graph

OPTIONS
  -h, --help  show CLI help

See code: src/commands/graph.ts

netvissoc help [COMMAND]

display help for netvissoc

USAGE
  $ netvissoc help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

netvissoc link FROM TO TYPE

create a new relation between nodes (every pair if multiple)

USAGE
  $ netvissoc link FROM TO TYPE

ARGUMENTS
  FROM  starting node(s), comma-separated
  TO    ending node(s), comma-separated
  TYPE  relation type

OPTIONS
  -h, --help           show CLI help
  -i, --input=input    [default: .] input directory
  -n, --notes=notes    relation notes
  -o, --output=output  [default: .] output directory
  -u, --undirected     make edges both ways

EXAMPLE
  $ netvissoc link -i ./test -o ./test "Timothy Cavendish" "Denholme Cavendish" "brother" -u

See code: src/commands/link.ts

netvissoc list

list nodes and number of connections (extended)

USAGE
  $ netvissoc list

OPTIONS
  -h, --help              show CLI help
  -i, --input=input       [default: .] input directory
  -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
  --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)

EXAMPLE
  $ netvissoc list -i ./test -x

See code: src/commands/list.ts

netvissoc relink FROM TO OLD [NEW]

change or update a relation between nodes (every pair if multiple)

USAGE
  $ netvissoc relink FROM TO OLD [NEW]

ARGUMENTS
  FROM  starting node(s), comma-separated
  TO    ending node(s), comma-separated
  OLD   relation type to change/update
  NEW   relation type to change to (optional)

OPTIONS
  -h, --help           show CLI help
  -i, --input=input    [default: .] input directory
  -n, --notes=notes    updated relation notes
  -o, --output=output  [default: .] output directory
  -u, --undirected     change edges both ways

EXAMPLES
  $ netvissoc relink -i ./test -o ./test "Robert Frobisher" "Vyvyan Ayrs" "music buddy" "music enemy" -u
  $ netvissoc relink -i ./test -o ./test "Luisa Rey" "Rufus Sixsmith" "friend" -n "updated notes"

See code: src/commands/relink.ts

netvissoc rename OLD NEW

rename a node

USAGE
  $ netvissoc rename OLD NEW

ARGUMENTS
  OLD  old name
  NEW  new name

OPTIONS
  -h, --help           show CLI help
  -i, --input=input    [default: .] input directory
  -o, --output=output  [default: .] output directory

EXAMPLE
  $ netvissoc rename -i ./test -o ./test "Sonmi" "Sonmi-451"

See code: src/commands/rename.ts

netvissoc unlink FROM TO TYPE

remove a relation between nodes (every pair if multiple)

USAGE
  $ netvissoc unlink FROM TO TYPE

ARGUMENTS
  FROM  starting node(s), comma-separated
  TO    ending node(s), comma-separated
  TYPE  relation type

OPTIONS
  -h, --help           show CLI help
  -i, --input=input    [default: .] input directory
  -o, --output=output  [default: .] output directory
  -u, --undirected     remove edges both ways (if exist)

EXAMPLE
  $ netvissoc unlink -i ./test -o ./test "Zachry" "Meronym" "enemy"

See code: src/commands/unlink.ts