# Fluence CLI

Fluence is a decentralized serverless platform & computing marketplace powered
by blockchain economics. Fluence is a global, permissionless, scalable, and
secure alternative to centralized cloud computing platforms.

Fluence CLI is designed to be the only tool that you need to manage the life
cycle of applications written on [Fluence](https://fluence.network). It provides
project scaffolding, compilation, service deployment, dependency management and
installation, storage of keys and ids, etc.

## Installation and Usage

### Using install script

To download and install `fluence` use our `install.sh` script

```shell
curl -qL https://raw.githubusercontent.com/fluencelabs/cli/main/install.sh | bash
```

To select `fluence` version compatible with certain network (`stage`, `testnet`,
`kras`) run:

```shell
fluence update <network>
```

You will receive notifications about updates when new version is promoted.

For more information run:

```shell
fluence update --help
```

### Installing manually

-   download fluence archive for your platfrom from
    [latest release](https://github.com/fluencelabs/cli/releases/latest).
-   extract archive contents to default fluence user directory

    ```shell
    tar --strip-components=1 -xzf <archive> -C "${HOME}/.fluence/cli"
    ```

-   add `${HOME}/.fluence/cli/bin` to `$PATH`

### Using npm

Prerequisites:

-   Linux or MacOS (there are currently some bugs on Windows)
-   [Node.js = 18.x.x](https://nodejs.org/)

To install and try Fluence CLI, run:

```sh-session
$ npm install -g @fluencelabs/cli
$ fluence COMMAND
running command...
$ fluence
@fluencelabs/cli/0.0.0 linux-x64 node-v18.16.0
$ fluence --help [COMMAND]
USAGE
  $ fluence COMMAND
...
```

## Documentation

1. [A complete list of commands together with usage examples](./docs/commands/README.md)
1. [Documentation for all Fluence CLI configs](./docs/configs/README.md)
1. [Environment variables that affect Fluence CLI and are important for Fluence CLI maintainers](./example.env)

## Support

Please, file an [issue](https://github.com/fluencelabs/cli/issues) if you find a
bug. You can also contact us at [Discord](https://discord.com/invite/5qSnPZKh7u)
or [Telegram](https://t.me/fluence_project). We will do our best to resolve the
issue ASAP.

## Contributing

Any interested person is welcome to contribute to the project. Please, make sure
you read and follow some basic [rules](./CONTRIBUTING.md).

## License

All software code is copyright (c) Fluence Labs, Inc. under the
[Apache-2.0](./LICENSE) license.