# fluence-cli

> CLI to work with Fluence network

Latest version **0.0.1** (published 2020-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install fluence-cli
pnpm add fluence-cli
yarn add fluence-cli
bun add fluence-cli
```

Provides the command `fluence`.

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2020-08-28 |
| First published | 2020-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 5 |
| Unpacked size | 34.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 135 |
| Author | Fluence |
| Maintainers | diemyst |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/fluence-cli
- Repository: https://github.com/fluencelabs/fluence-cli
- Issues: https://github.com/fluencelabs/fluence-cli/issues
- npm.io page: https://npm.io/package/fluence-cli

## Dependencies (5)

- [tslib](https://npm.io/package/tslib.md) ^1.13.0
- [fluence](https://npm.io/package/fluence.md) 0.7.11
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.17.0
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.8.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2020-08-28

## README

fluence-cli
===========

CLI to work with Fluence network

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/fluence-cli.svg)](https://npmjs.org/package/fluence-cli)
[![CircleCI](https://circleci.com/gh/fluencelabs/fluence-cli/tree/master.svg?style=shield)](https://circleci.com/gh/fluencelabs/fluence-cli/tree/master)
[![Downloads/week](https://img.shields.io/npm/dw/fluence-cli.svg)](https://npmjs.org/package/fluence-cli)
[![License](https://img.shields.io/npm/l/fluence-cli.svg)](https://github.com/fluencelabs/fluence-cli/blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g fluence-cli
$ fluence COMMAND
running command...
$ fluence (-v|--version|version)
fluence-cli/0.0.1 linux-x64 node-v12.13.1
$ fluence --help [COMMAND]
USAGE
  $ fluence COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`fluence add_blueprint`](#fluence-add_blueprint)
* [`fluence add_module`](#fluence-add_module)
* [`fluence blueprints`](#fluence-blueprints)
* [`fluence call`](#fluence-call)
* [`fluence create_service`](#fluence-create_service)
* [`fluence help [COMMAND]`](#fluence-help-command)
* [`fluence interfaces`](#fluence-interfaces)
* [`fluence modules`](#fluence-modules)

## `fluence add_blueprint`

Add a blueprint to a node.

```
USAGE
  $ fluence add_blueprint

OPTIONS
  -P, --peer=peer              (required) Host to connect to
  -d, --deps=deps              (required) List of blueprint dependencies
  -h, --help                   show CLI help
  -h, --host=host              [default: 127.0.0.1] Host to connect to
  -l, --logLevel=logLevel      [default: info] 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent'
  -n, --name=name              (required) A name of a blueprint
  -p, --port=port              [default: 9100] Port to connect to

  -s, --secretKey=secretKey    Client's secret key. A new one will be generated and printed if this flag is not
                               specified

  -t, --targetPeer=targetPeer  Host to connect to

EXAMPLE
  $ fluence add_blueprint
  [
     '..',
     '..'
  ]
```

_See code: [src/commands/add_blueprint.ts](https://github.com/fluencelabs/fluence-cli/blob/v0.0.1/src/commands/add_blueprint.ts)_

## `fluence add_module`

Add a module to a node.

```
USAGE
  $ fluence add_module

OPTIONS
  -P, --peer=peer              (required) Host to connect to
  -a, --path=path              (required) A path to a WASM module
  -h, --help                   show CLI help
  -h, --host=host              [default: 127.0.0.1] Host to connect to
  -l, --logLevel=logLevel      [default: info] 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent'
  -n, --name=name              (required) A name of a module
  -p, --port=port              [default: 9100] Port to connect to

  -s, --secretKey=secretKey    Client's secret key. A new one will be generated and printed if this flag is not
                               specified

  -t, --targetPeer=targetPeer  Host to connect to

EXAMPLE
  $ fluence add_module
  [
     '..',
     '..'
  ]
```

_See code: [src/commands/add_module.ts](https://github.com/fluencelabs/fluence-cli/blob/v0.0.1/src/commands/add_module.ts)_

## `fluence blueprints`

Get a list of blueprints from a node.

```
USAGE
  $ fluence blueprints

OPTIONS
  -P, --peer=peer              (required) Host to connect to
  -h, --help                   show CLI help
  -h, --host=host              [default: 127.0.0.1] Host to connect to
  -l, --logLevel=logLevel      [default: info] 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent'
  -p, --port=port              [default: 9100] Port to connect to

  -s, --secretKey=secretKey    Client's secret key. A new one will be generated and printed if this flag is not
                               specified

  -t, --targetPeer=targetPeer  Host to connect to

EXAMPLE
  $ fluence blueprints
  [
     '..',
     '..'
  ]
```

_See code: [src/commands/blueprints.ts](https://github.com/fluencelabs/fluence-cli/blob/v0.0.1/src/commands/blueprints.ts)_

## `fluence call`

Call a service.

```
USAGE
  $ fluence call

OPTIONS
  -P, --peer=peer              (required) Host to connect to
  -S, --service=service        (required) Id of a service
  -a, --args=args              (required) Arguments
  -f, --fname=fname            Name of a function
  -h, --help                   show CLI help
  -h, --host=host              [default: 127.0.0.1] Host to connect to
  -l, --logLevel=logLevel      [default: info] 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent'
  -m, --module=module          (required) Id of a module
  -p, --port=port              [default: 9100] Port to connect to

  -s, --secretKey=secretKey    Client's secret key. A new one will be generated and printed if this flag is not
                               specified

  -t, --targetPeer=targetPeer  (required) Host to connect to

EXAMPLE
  $ fluence call
  fluence call --host 134.209.186.43 --port 9100 --peer 12D3KooWPnLxnY71JDxvB3zbjKu9k1BCYNthGZw6iGrLYsR1RnWM -t 
  12D3KooWPnLxnY71JDxvB3zbjKu9k1BCYNthGZw6iGrLYsR1RnWM -S b9ec12ba-c69f-4cf3-991a-7590aec7b662 -m 
  811deb12-a9ab-4cba-b219-9b48ce7dd5ce -a "[\"123\"]" -f greeting
  [
     '..',
     '..'
  ]
```

_See code: [src/commands/call.ts](https://github.com/fluencelabs/fluence-cli/blob/v0.0.1/src/commands/call.ts)_

## `fluence create_service`

Create a service by a blueprint.

```
USAGE
  $ fluence create_service

OPTIONS
  -P, --peer=peer              (required) Host to connect to
  -b, --blueprint=blueprint    (required) A blueprint to create a service
  -h, --help                   show CLI help
  -h, --host=host              [default: 127.0.0.1] Host to connect to
  -l, --logLevel=logLevel      [default: info] 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent'
  -p, --port=port              [default: 9100] Port to connect to

  -s, --secretKey=secretKey    Client's secret key. A new one will be generated and printed if this flag is not
                               specified

  -t, --targetPeer=targetPeer  Host to connect to

EXAMPLE
  $ fluence create_service
  [
     '..',
     '..'
  ]
```

_See code: [src/commands/create_service.ts](https://github.com/fluencelabs/fluence-cli/blob/v0.0.1/src/commands/create_service.ts)_

## `fluence help [COMMAND]`

display help for fluence

```
USAGE
  $ fluence help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_

## `fluence interfaces`

Get a list of interfaces from a node.

```
USAGE
  $ fluence interfaces

OPTIONS
  -P, --peer=peer              (required) Host to connect to
  -h, --help                   show CLI help
  -h, --host=host              [default: 127.0.0.1] Host to connect to
  -l, --logLevel=logLevel      [default: info] 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent'
  -p, --port=port              [default: 9100] Port to connect to

  -s, --secretKey=secretKey    Client's secret key. A new one will be generated and printed if this flag is not
                               specified

  -t, --targetPeer=targetPeer  Host to connect to

EXAMPLE
  $ fluence interfaces
  [
     '..',
     '..'
  ]
```

_See code: [src/commands/interfaces.ts](https://github.com/fluencelabs/fluence-cli/blob/v0.0.1/src/commands/interfaces.ts)_

## `fluence modules`

Get a list of modules from a node.

```
USAGE
  $ fluence modules

OPTIONS
  -P, --peer=peer              (required) Host to connect to
  -h, --help                   show CLI help
  -h, --host=host              [default: 127.0.0.1] Host to connect to
  -l, --logLevel=logLevel      [default: info] 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent'
  -p, --port=port              [default: 9100] Port to connect to

  -s, --secretKey=secretKey    Client's secret key. A new one will be generated and printed if this flag is not
                               specified

  -t, --targetPeer=targetPeer  Host to connect to

EXAMPLE
  $ fluence modules
  [
     '..',
     '..'
  ]
```

_See code: [src/commands/modules.ts](https://github.com/fluencelabs/fluence-cli/blob/v0.0.1/src/commands/modules.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/fluence-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._