Skip to content

Commit

Permalink
Apply automatic changes
Browse files Browse the repository at this point in the history
  • Loading branch information
shamsartem authored and github-actions[bot] committed Dec 19, 2024
1 parent 28e4534 commit f95d04e
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions packages/cli/package/docs/commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ Run docker-compose.yaml using docker compose and set up provider using all the o

```
USAGE
$ fluence local up [--no-input] [--servers <value>] [--timeout <value>] [--priv-key <private-key>]
$ fluence local up [--no-input] [--peers <value>] [--timeout <value>] [--priv-key <private-key>]
[--quiet-pull] [-d] [--build] [--flags <--flag arg>] [-r] [--no-wait] [--no-set-up]
FLAGS
Expand All @@ -262,11 +262,11 @@ FLAGS
--no-set-up Don't set up provider, offer, commitments and deposit collateral, so there will be no
active offer on the network after command is finished
--no-wait Don't wait for services to be running|healthy
--peers=<value> Number of peers to generate when a new provider.yaml is created
--priv-key=<private-key> !WARNING! for debug purposes only. Passing private keys through flags is unsecure. On
local env 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 is used by
default when CLI is used in non-interactive mode
--quiet-pull Pull without printing progress information
--servers=<value> Number of servers to generate when a new provider.yaml is created
--timeout=<value> [default: 120] Timeout in seconds for attempting to register local network on local
peers
Expand Down Expand Up @@ -590,7 +590,7 @@ FLAGS
--env=<testnet | mainnet | stage | local> Fluence Environment to use when running the command
--no-input Don't interactively ask for any input from the user
--no-withdraw Is used only when --reset-peer-secrets flag is present. Will not withdraw
tokens from noxes (if you don't need it or it fails for some reason)
tokens from peers (if you don't need it or it fails for some reason)
--priv-key=<private-key> !WARNING! for debug purposes only. Passing private keys through flags is
unsecure. On local env
0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 is used
Expand All @@ -610,7 +610,7 @@ _See code: [src/commands/provider/gen.ts](https://github.com/fluencelabs/cli/blo

## `fluence provider info`

Print nox signing wallets and peer ids. Alias: fluence provider i
Print peer signing wallets and peer ids. Alias: fluence provider i

```
USAGE
Expand All @@ -632,7 +632,7 @@ FLAGS
by default when CLI is used in non-interactive mode
DESCRIPTION
Print nox signing wallets and peer ids. Alias: fluence provider i
Print peer signing wallets and peer ids. Alias: fluence provider i
```

_See code: [src/commands/provider/info.ts](https://github.com/fluencelabs/cli/blob/fluence-cli-v0.22.0/src/commands/provider/info.ts)_
Expand All @@ -643,18 +643,17 @@ Init provider config. Creates a provider.yaml file

```
USAGE
$ fluence provider init [--no-input] [--servers <value>] [--env <testnet | mainnet | stage | local>] [--priv-key
<private-key>] [--no-vm]
$ fluence provider init [--no-input] [--peers <value>] [--env <testnet | mainnet | stage | local>] [--priv-key
<private-key>]
FLAGS
--env=<testnet | mainnet | stage | local> Fluence Environment to use when running the command
--no-input Don't interactively ask for any input from the user
--no-vm Generate provider.yaml without vm configuration
--peers=<value> Number of peers to generate when a new provider.yaml is created
--priv-key=<private-key> !WARNING! for debug purposes only. Passing private keys through flags is
unsecure. On local env
0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 is used
by default when CLI is used in non-interactive mode
--servers=<value> Number of servers to generate when a new provider.yaml is created
DESCRIPTION
Init provider config. Creates a provider.yaml file
Expand Down Expand Up @@ -790,15 +789,15 @@ _See code: [src/commands/provider/register.ts](https://github.com/fluencelabs/cl

## `fluence provider tokens-distribute`

Distribute FLT tokens to noxes. Alias: fluence provider td
Distribute FLT tokens to peers. Alias: fluence provider td

```
USAGE
$ fluence provider tokens-distribute [--no-input] [--env <testnet | mainnet | stage | local>] [--priv-key <private-key>]
[--peer-names <peer-1,peer-2>] [--offers <offer-1,offer-2>] [--amount <value>]
FLAGS
--amount=<value> Amount of FLT tokens to distribute to noxes
--amount=<value> Amount of FLT tokens to distribute to peers
--env=<testnet | mainnet | stage | local> Fluence Environment to use when running the command
--no-input Don't interactively ask for any input from the user
--offers=<offer-1,offer-2> Comma-separated list of offer names. To use all of your offers: --offers
Expand All @@ -811,22 +810,22 @@ FLAGS
by default when CLI is used in non-interactive mode
DESCRIPTION
Distribute FLT tokens to noxes. Alias: fluence provider td
Distribute FLT tokens to peers. Alias: fluence provider td
```

_See code: [src/commands/provider/tokens-distribute.ts](https://github.com/fluencelabs/cli/blob/fluence-cli-v0.22.0/src/commands/provider/tokens-distribute.ts)_

## `fluence provider tokens-withdraw`

Withdraw FLT tokens from noxes. Alias: fluence provider tw
Withdraw FLT tokens from peers. Alias: fluence provider tw

```
USAGE
$ fluence provider tokens-withdraw [--no-input] [--env <testnet | mainnet | stage | local>] [--priv-key <private-key>]
[--peer-names <peer-1,peer-2>] [--offers <offer-1,offer-2>] [--amount <value>]
FLAGS
--amount=<value> Amount of FLT tokens to withdraw from noxes. Use --amount max to withdraw
--amount=<value> Amount of FLT tokens to withdraw from peers. Use --amount max to withdraw
maximum possible amount
--env=<testnet | mainnet | stage | local> Fluence Environment to use when running the command
--no-input Don't interactively ask for any input from the user
Expand All @@ -840,7 +839,7 @@ FLAGS
by default when CLI is used in non-interactive mode
DESCRIPTION
Withdraw FLT tokens from noxes. Alias: fluence provider tw
Withdraw FLT tokens from peers. Alias: fluence provider tw
```

_See code: [src/commands/provider/tokens-withdraw.ts](https://github.com/fluencelabs/cli/blob/fluence-cli-v0.22.0/src/commands/provider/tokens-withdraw.ts)_
Expand Down

0 comments on commit f95d04e

Please sign in to comment.