@runspace/cli

Runspace daemon cli

Installing

Using docker

$ docker run --net=host -it docker.pkg.github.com/runspacegit/cli/runspace-cli:latest bash
root@docker-desktop:/app# runspace help

Using local machine with Node.js

$ # lowdb types is missing some where, so its temproary solution.
$ yarn global add @types/lowdb @runspace/cli
$ # or using npm
$ npm i -g @types/lowdb @runspace/cli
$ runspace help

• Usage
• Commands

Usage

$ npm install -g @runspace/cli
$ runspace COMMAND
running command...
$ runspace (-v|--version|version)
@runspace/cli/0.1.7 darwin-x64 node-v12.16.3
$ runspace --help [COMMAND]
USAGE
  $ runspace COMMAND
...

Commands

• runspace autocomplete [SHELL]
• runspace commands
• runspace daemon
• runspace daemon:broadcast [FILE]
• runspace daemon:nodes
• runspace daemon:runner
• runspace daemon:runner:start
• runspace daemon:runner:stop
• runspace help [COMMAND]
• runspace run [FILE]
• runspace update [CHANNEL]

runspace autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ runspace autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

runspace commands

list all the commands

USAGE
  $ runspace commands

OPTIONS
  -h, --help  show CLI help
  -j, --json  output in json format
  --hidden    also show hidden commands

See code: @oclif/plugin-commands

runspace daemon

starts daemon

USAGE
  $ runspace daemon

EXAMPLE
  $ runspace daemon

See code: src/commands/daemon/index.ts

runspace daemon:broadcast [FILE]

broadcasts runspace daemon script inside network

USAGE
  $ runspace daemon:broadcast [FILE]

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ runspace daemon:broadcast ./examples/functions/hello.js

See code: src/commands/daemon/broadcast.ts

runspace daemon:nodes

discovers nodes

USAGE
  $ runspace daemon:nodes

EXAMPLE
  $ runspace daemon:nodes

See code: src/commands/daemon/nodes.ts

runspace daemon:runner

shows daemon status

USAGE
  $ runspace daemon:runner

EXAMPLE
  $ runspace daemon:runner
  ⛓ Runspace Daemon Process List
  Name               Status  User 
  runspace-daemon    stopped 0x77

See code: src/commands/daemon/runner/index.ts

runspace daemon:runner:start

starts daemon

USAGE
  $ runspace daemon:runner:start

EXAMPLES
  $ runspace daemon:runner:start
  Starting daemon in the background... ✅
  $ runspace daemon:runner:start
  Starting daemon in the background... ❌

See code: src/commands/daemon/runner/start.ts

runspace daemon:runner:stop

starts daemon

USAGE
  $ runspace daemon:runner:stop

EXAMPLES
  $ runspace daemon:runner:stop
  Stopping background daemon... ✅
  $ runspace daemon:runner:stop
  Stopping background daemon... ❌

See code: src/commands/daemon/runner/stop.ts

runspace help [COMMAND]

display help for runspace

USAGE
  $ runspace help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

runspace run [FILE]

runs runspace function locally

USAGE
  $ runspace run [FILE]

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ runspace run examples/functions/hello.js
  { log: '', data: [ 'Hello, World!' ] }
  running... done

See code: src/commands/run.ts

runspace update [CHANNEL]

update the runspace CLI

USAGE
  $ runspace update [CHANNEL]

See code: @oclif/plugin-update