Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More
Socket
Book a DemoInstallSign in
Socket

@mesg/cli

Package Overview
Dependencies
Maintainers
2
Versions
17
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mesg/cli

MESG CLI

latest
Source
npmnpm
Version
0.3.0
Version published
Maintainers
2
Created
Source

mesg-cli

MESG Engine CLI

oclif Version Downloads/week License

  • Usage
  • Commands

Usage

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

Commands

mesg-cli daemon:logs

Show the Engine's logs

USAGE
  $ mesg-cli daemon:logs

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --[no-]follow    Follow logs
  --host=host      [default: localhost] Host to access the MESG engine
  --name=name      (required) [default: engine] Name of the docker service running the engine
  --tail=tail      [default: 10000] Display the last N lines

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

mesg-cli daemon:start

Start the Engine

USAGE
  $ mesg-cli daemon:start

OPTIONS
  -h, --help           show CLI help
  -p, --port=port      [default: 50052] Port to access the MESG engine
  -q, --quiet          Display only essential information
  --host=host          [default: localhost] Host to access the MESG engine
  --lcd-port=lcd-port  (required) [default: 1317] Port to use for LCD interaction
  --name=name          (required) [default: engine] Name of the docker service running the engine
  --network=network    Name of the network to connect to
  --p2p-port=p2p-port  (required) [default: 26656] Port to use for p2p interaction
  --path=path          (required) [default: /Users/antho/.mesg] Path to the mesg folder
  --[no-]pull          Pull the latest image of the given version
  --version=version    (required) [default: v0.19] Version of the Engine to run

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

mesg-cli daemon:status

Get the Engine's status

USAGE
  $ mesg-cli daemon:status

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --host=host      [default: localhost] Host to access the MESG engine
  --name=name      (required) [default: engine] Name of the docker service running the engine

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

mesg-cli daemon:stop

Stop the Engine

USAGE
  $ mesg-cli daemon:stop

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --host=host      [default: localhost] Host to access the MESG engine
  --name=name      (required) [default: engine] Name of the docker service running the engine

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

mesg-cli help [COMMAND]

display help for mesg-cli

USAGE
  $ mesg-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mesg-cli process:compile [PROCESS_FILE]

Compile a process

USAGE
  $ mesg-cli process:compile [PROCESS_FILE]

ARGUMENTS
  PROCESS_FILE  Path of a process file

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --dev            compile the process and automatically deploy and start all the services
  --env=FOO=BAR    Set environment variables
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/process/compile.ts

mesg-cli process:create DEFINITION

Create a process

USAGE
  $ mesg-cli process:create DEFINITION

ARGUMENTS
  DEFINITION  Process's definition. Use process:compile first to build process definition

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/process/create.ts

mesg-cli process:delete PROCESS_HASH...

Delete one or many processes

USAGE
  $ mesg-cli process:delete PROCESS_HASH...

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --confirm        Confirm deletion
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/process/delete.ts

mesg-cli process:detail PROCESS_HASH

Display detailed information on a process

USAGE
  $ mesg-cli process:detail PROCESS_HASH

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/process/detail.ts

mesg-cli process:dev [PROCESS]

Run a process in development mode

USAGE
  $ mesg-cli process:dev [PROCESS]

ARGUMENTS
  PROCESS  [default: ./] Path of the process

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --dev            compile the process and automatically deploy and start all the services
  --env=FOO=BAR    Set environment variables
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/process/dev.ts

mesg-cli process:list

List processes

USAGE
  $ mesg-cli process:list

OPTIONS
  -h, --help         show CLI help
  -p, --port=port    [default: 50052] Port to access the MESG engine
  -q, --quiet        Display only essential information
  -x, --extended     show extra columns
  --columns=columns  only show provided columns (comma-separated)
  --csv              output is csv format
  --filter=filter    filter property by partial string matching, ex: name=foo
  --host=host        [default: localhost] Host to access the MESG engine
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --sort=sort        property to sort by (prepend '-' for descending)

See code: src/commands/process/list.ts

mesg-cli process:logs PROCESS_HASH

Log the executions related to a process

USAGE
  $ mesg-cli process:logs PROCESS_HASH

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --[no-]follow    Follow logs
  --host=host      [default: localhost] Host to access the MESG engine
  --name=name      (required) [default: engine] Name of the docker service running the engine
  --tail=tail      [default: 10000] Display the last N lines

See code: src/commands/process/logs.ts

mesg-cli service:compile [SERVICE]

Compile a service and upload its source to IPFS server

USAGE
  $ mesg-cli service:compile [SERVICE]

ARGUMENTS
  SERVICE  [default: ./] Path or url of a service

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/service/compile.ts

mesg-cli service:create DEFINITION

Create a service

USAGE
  $ mesg-cli service:create DEFINITION

ARGUMENTS
  DEFINITION  Service's definition. Use service:compile first to build service definition

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --host=host      [default: localhost] Host to access the MESG engine
  --start          Automatically start the service once created

See code: src/commands/service/create.ts

mesg-cli service:detail SERVICE_HASH

Display detailed information on a service

USAGE
  $ mesg-cli service:detail SERVICE_HASH

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/service/detail.ts

mesg-cli service:dev [SERVICE]

Run a service in development mode

USAGE
  $ mesg-cli service:dev [SERVICE]

ARGUMENTS
  SERVICE  [default: ./] Path or url of a service

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --env=FOO=BAR    Set environment variables
  --host=host      [default: localhost] Host to access the MESG engine
  --start          Automatically start the service once created

See code: src/commands/service/dev.ts

mesg-cli service:doc [SERVICE]

Generate documentation for service and print it on stdout

USAGE
  $ mesg-cli service:doc [SERVICE]

ARGUMENTS
  SERVICE  [default: ./] Path of a service

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  -s, --save       Save to default readme file
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/service/doc.ts

mesg-cli service:execute RUNNER_HASH TASK

Execute a task on a running service

USAGE
  $ mesg-cli service:execute RUNNER_HASH TASK

ARGUMENTS
  RUNNER_HASH  The hash of the runner that will execute this execution
  TASK         Task key

OPTIONS
  -d, --data=key=value   Task inputs
  -h, --help             show CLI help
  -j, --json=json        Path to a JSON file containing the task inputs
  -p, --port=port        [default: 50052] Port to access the MESG engine
  -q, --quiet            Display only essential information
  --eventHash=eventHash  Event hash to create the execution with
  --host=host            [default: localhost] Host to access the MESG engine

See code: src/commands/service/execute.ts

mesg-cli service:init DIR

Initialize a service from a template

USAGE
  $ mesg-cli service:init DIR

ARGUMENTS
  DIR  Directory to initialize a service into

OPTIONS
  -h, --help               show CLI help
  -p, --port=port          [default: 50052] Port to access the MESG engine
  -q, --quiet              Display only essential information
  -t, --template=template  Specify the template URL to use
  --host=host              [default: localhost] Host to access the MESG engine

See code: src/commands/service/init.ts

mesg-cli service:list

List running services

USAGE
  $ mesg-cli service:list

OPTIONS
  -h, --help         show CLI help
  -p, --port=port    [default: 50052] Port to access the MESG engine
  -q, --quiet        Display only essential information
  -x, --extended     show extra columns
  --columns=columns  only show provided columns (comma-separated)
  --csv              output is csv format
  --filter=filter    filter property by partial string matching, ex: name=foo
  --host=host        [default: localhost] Host to access the MESG engine
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --sort=sort        property to sort by (prepend '-' for descending)

See code: src/commands/service/list.ts

mesg-cli service:logs RUNNER_HASH

Fetch the logs of a service

USAGE
  $ mesg-cli service:logs RUNNER_HASH

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --event=event    Display a specific event
  --[no-]events    Display events
  --[no-]follow    Follow log output
  --host=host      [default: localhost] Host to access the MESG engine
  --[no-]results   Display results
  --tail=tail      [default: 10000] Display the last N lines
  --task=task      Display a specific task results

See code: src/commands/service/logs.ts

mesg-cli service:start SERVICE_HASH

Start a service by creating a new runner

USAGE
  $ mesg-cli service:start SERVICE_HASH

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --env=FOO=BAR    Set environment variables
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/service/start.ts

mesg-cli service:stop RUNNER_HASH...

Stop one or more running service

USAGE
  $ mesg-cli service:stop RUNNER_HASH...

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 50052] Port to access the MESG engine
  -q, --quiet      Display only essential information
  --confirm        Confirm deletion
  --delete-data    Delete running service persistent data
  --host=host      [default: localhost] Host to access the MESG engine

See code: src/commands/service/stop.ts

FAQs

Package last updated on 04 Mar 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts