@blockforfun/cli

cli

BlockFor.fun CLI

• Plugins
• Usage
• Commands

Plugins

Bundled plugins

• @blockforfun/plugin-git
• @blockforfun/plugin-build

Usage

$ npm install -g @blockforfun/cli
$ blockfun COMMAND
running command...
$ blockfun (-v|--version|version)
@blockforfun/cli/7.0.0 win32-x64 node-v10.10.0
$ blockfun --help [COMMAND]
USAGE
  $ blockfun COMMAND
...

Commands

• blockfun build:sqlite SOURCE TARGET
• blockfun help [COMMAND]
• blockfun list:json SOURCE [TARGET]
• blockfun list:text SOURCE [TARGET]
• blockfun read:json SOURCE PATH [TARGET]
• blockfun read:text SOURCE PATH [TARGET]

blockfun build:sqlite SOURCE TARGET

builds sqlite3 database from a BlockFor.fun git registry

USAGE
  $ blockfun build:sqlite SOURCE TARGET

ARGUMENTS
  SOURCE  git source repository URL or path
  TARGET  path to target sqlite3 database

OPTIONS
  -f, --fetch=fetch  git fetch repository URL
  -r, --ref=ref      [default: refs/heads/master] git ref to read from
  -s, --spec=spec    [default: refs/heads/*:refs/heads/*] git refspec to fetch

See code: @blockforfun/plugin-build

blockfun help [COMMAND]

display help for blockfun

USAGE
  $ blockfun help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

blockfun list:json SOURCE [TARGET]

lists entries in json format from a BlockFor.fun git registry

USAGE
  $ blockfun list:json SOURCE [TARGET]

ARGUMENTS
  SOURCE  git source repository URL or path
  TARGET  path to target text file

OPTIONS
  -f, --fetch=fetch  git fetch repository URL
  -r, --ref=ref      [default: refs/heads/master] git ref to read from
  -s, --spec=spec    [default: refs/heads/*:refs/heads/*] git refspec to fetch

ALIASES
  $ blockfun ls:json

See code: @blockforfun/plugin-git

blockfun list:text SOURCE [TARGET]

lists entries in text format from a BlockFor.fun git registry

USAGE
  $ blockfun list:text SOURCE [TARGET]

ARGUMENTS
  SOURCE  git source repository URL or path
  TARGET  path to target text file

OPTIONS
  -f, --fetch=fetch  git fetch repository URL
  -r, --ref=ref      [default: refs/heads/master] git ref to read from
  -s, --spec=spec    [default: refs/heads/*:refs/heads/*] git refspec to fetch

ALIASES
  $ blockfun ls
  $ blockfun ls:text

See code: @blockforfun/plugin-git

blockfun read:json SOURCE PATH [TARGET]

reads entries in json format from a BlockFor.fun git registry

USAGE
  $ blockfun read:json SOURCE PATH [TARGET]

ARGUMENTS
  SOURCE  git source repository URL or path
  PATH    path to git file
  TARGET  path to target text file

OPTIONS
  -f, --fetch=fetch  git fetch repository URL
  -r, --ref=ref      [default: refs/heads/master] git ref to read from
  -s, --spec=spec    [default: refs/heads/*:refs/heads/*] git refspec to fetch

ALIASES
  $ blockfun get:json

See code: @blockforfun/plugin-git

blockfun read:text SOURCE PATH [TARGET]

reads entries in text format from a BlockFor.fun git registry

USAGE
  $ blockfun read:text SOURCE PATH [TARGET]

ARGUMENTS
  SOURCE  git source repository URL or path
  PATH    path to git file
  TARGET  path to target text file

OPTIONS
  -f, --fetch=fetch  git fetch repository URL
  -r, --ref=ref      [default: refs/heads/master] git ref to read from
  -s, --spec=spec    [default: refs/heads/*:refs/heads/*] git refspec to fetch

ALIASES
  $ blockfun get
  $ blockfun get:text

See code: @blockforfun/plugin-git

Changelog

7.0.0 (2018-11-27)

Code Refactoring

• Relocate files in and remove lib folder (901ebb5)

BREAKING CHANGES

• This changes paths in plugin-git