npm

Need private packages and team management tools?Check out npm Orgs. »

mesg-cli

1.1.0 • Public • Published

mesg-cli

MESG Engine CLI

oclif Version Downloads/week License

Usage

$ npm install -g mesg-cli
$ mesg-cli COMMAND
running command...
$ mesg-cli (-v|--version|version)
mesg-cli/1.1.0 darwin-x64 node-v10.16.0
$ mesg-cli --help [COMMAND]
USAGE
  $ mesg-cli COMMAND
...

Commands

mesg-cli account:create

Create an account

USAGE
  $ mesg-cli account:create

OPTIONS
  -h, --help               show CLI help
  -q, --quiet              Display only essential information
  --passphrase=passphrase  Passphrase of the account

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

mesg-cli account:delete ADDRESS

Delete an account

USAGE
  $ mesg-cli account:delete ADDRESS

OPTIONS
  -h, --help               show CLI help
  -q, --quiet              Display only essential information
  --passphrase=passphrase  Passphrase of the account

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

mesg-cli account:export ADDRESS

Export an existing account

USAGE
  $ mesg-cli account:export ADDRESS

OPTIONS
  -h, --help               show CLI help
  -q, --quiet              Display only essential information
  --passphrase=passphrase  Passphrase of the account

See code: src/commands/account/export.ts

mesg-cli account:import ACCOUNT

Import an account

USAGE
  $ mesg-cli account:import ACCOUNT

ARGUMENTS
  ACCOUNT  Account definition in JSON (could be retrieved with account:export)

OPTIONS
  -h, --help               show CLI help
  -q, --quiet              Display only essential information
  --passphrase=passphrase  Passphrase of the account

See code: src/commands/account/import.ts

mesg-cli account:import-private-key PRIVATE_KEY

Import an account with a private key

USAGE
  $ mesg-cli account:import-private-key PRIVATE_KEY

ARGUMENTS
  PRIVATE_KEY  Private key of the account

OPTIONS
  -h, --help               show CLI help
  -q, --quiet              Display only essential information
  --passphrase=passphrase  Passphrase of the account

See code: src/commands/account/import-private-key.ts

mesg-cli account:list

List accounts

USAGE
  $ mesg-cli account:list

OPTIONS
  -h, --help         show CLI help
  -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
  --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/account/list.ts

mesg-cli daemon:logs

Show the Engine's logs

USAGE
  $ mesg-cli daemon:logs

OPTIONS
  -h, --help     show CLI help
  -q, --quiet    Display only essential information
  --[no-]follow  Follow logs
  --name=name    (required) [default: engine] Name of the docker service running the engine
  --tail=tail    [default: -1] 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
  -q, --quiet                                      Display only essential information
  --log-force-colors                               Log force colors
  --log-format=(text|json)                         [default: text] Log format
  --log-level=(debug|info|warn|error|fatal|panic)  [default: info] Log level

  --name=name                                      (required) [default: engine] Name of the docker service running the
                                                   engine

  --version=version                                (required) [default: v0.11.0] 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
  -q, --quiet  Display only essential information
  --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
  -q, --quiet  Display only essential information
  --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 marketplace:create-offer SID

Create an offer of a service

USAGE
  $ mesg-cli marketplace:create-offer SID

ARGUMENTS
  SID  SID of the service

OPTIONS
  -a, --account=account        Account to use
  -h, --help                   show CLI help
  -p, --passphrase=passphrase  Passphrase to unlock the account
  -q, --quiet                  Display only essential information
  --duration=duration          (required) Duration (in seconds)
  --price=price                (required) Price (in MESG tokens)

See code: src/commands/marketplace/create-offer.ts

mesg-cli marketplace:publish SERVICE_PATH

Publish a service

USAGE
  $ mesg-cli marketplace:publish SERVICE_PATH

ARGUMENTS
  SERVICE_PATH  [default: ./] Path of the service

OPTIONS
  -a, --account=account        Account to use
  -h, --help                   show CLI help
  -p, --passphrase=passphrase  Passphrase to unlock the account
  -q, --quiet                  Display only essential information

See code: src/commands/marketplace/publish.ts

mesg-cli marketplace:purchase SID OFFER_ID

Purchase a service

USAGE
  $ mesg-cli marketplace:purchase SID OFFER_ID

ARGUMENTS
  SID       ID of the service
  OFFER_ID  ID of the offer

OPTIONS
  -a, --account=account        Account to use
  -h, --help                   show CLI help
  -p, --passphrase=passphrase  Passphrase to unlock the account
  -q, --quiet                  Display only essential information

See code: src/commands/marketplace/purchase.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 ([https|mesg]://) of a service

OPTIONS
  -h, --help   show CLI help
  -q, --quiet  Display only essential information

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
  -q, --quiet  Display only essential information

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

mesg-cli service:delete SERVICE_HASH...

Delete one or many services

USAGE
  $ mesg-cli service:delete SERVICE_HASH...

OPTIONS
  -h, --help   show CLI help
  -q, --quiet  Display only essential information
  --confirm    Confirm deletion

See code: src/commands/service/delete.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
  -q, --quiet  Display only essential information

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 ([https|mesg]://) of a service

OPTIONS
  -h, --help     show CLI help
  -q, --quiet    Display only essential information
  --env=FOO=BAR  Set environment variables

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
  -q, --quiet  Display only essential information
  -s, --save   Save to default readme file

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

mesg-cli service:execute INSTANCE_HASH TASK

Execute a task on a running service

USAGE
  $ mesg-cli service:execute INSTANCE_HASH TASK

ARGUMENTS
  INSTANCE_HASH
  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
  -q, --quiet           Display only essential information

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
  -q, --quiet              Display only essential information
  -t, --template=template  Specify the template URL to use

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
  -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
  --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 INSTANCE_HASH

Fetch the logs of a service

USAGE
  $ mesg-cli service:logs INSTANCE_HASH

OPTIONS
  -h, --help      show CLI help
  -q, --quiet     Display only essential information
  --event=event   Display a specific event
  --[no-]events   Display events
  --[no-]follow   Follow log output
  --[no-]results  Display results
  --tail=tail     [default: -1] 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 instance

USAGE
  $ mesg-cli service:start SERVICE_HASH

OPTIONS
  -h, --help     show CLI help
  -q, --quiet    Display only essential information
  --env=FOO=BAR  Set environment variables

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

mesg-cli service:stop INSTANCE_HASH...

Stop one or more running service

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

OPTIONS
  -h, --help     show CLI help
  -q, --quiet    Display only essential information
  --confirm      Confirm deletion
  --delete-data  Delete running service persistent data

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

Keywords

install

npm i mesg-cli

Downloadsweekly downloads

26

version

1.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability