Skip to content

Commit

Permalink
docs: expand on node.js requirement in readme (#510)
Browse files Browse the repository at this point in the history
  • Loading branch information
Cafe137 authored Jun 26, 2024
1 parent 8911045 commit d3cd5a0
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,20 +78,17 @@ For the currently supported operations, see the [Commands](#commands) section.

## Installation

### From npm
Requires Node.js 18 or higher. It is recommended to use [NVM](https://github.com/nvm-sh/nvm) to manage Node.js versions.

To install globally (requires `npm root --global` to be writable):
> Warning! Installing Node.js via package managers (e.g. `apt`, `yum`, `brew`) may not work as expected, as they may
> install an older version of Node.js.
```sh
npm install --global @ethersphere/swarm-cli
```
### From npm

To install locally:
Install globally:

```sh
cd [some directory for nodejs files]
npm install @ethersphere/swarm-cli
./node_modules/.bin/swarm-cli --help
npm install --global @ethersphere/swarm-cli
```

### From source
Expand All @@ -111,7 +108,7 @@ Running a command with the `--help` option prints out the usage of a command.
Running `swarm-cli` without arguments prints the available commands:

```
Swarm CLI 1.5.0 - Manage your Bee node and interact with the Swarm network via the CLI
Swarm CLI 2.11.0 - Manage your Bee node and interact with the Swarm network via the CLI
█ Usage:
Expand All @@ -126,15 +123,18 @@ cheque Deposit, withdraw and manage cheques
stamp Buy, list and show postage stamps
pss Send, receive, or subscribe to PSS messages
manifest Operate on manifests
utility Utility commands for managing wallets
Run 'swarm-cli GROUP --help' to see available commands in a group
█ Available Commands:
upload Upload file to Swarm
download Download arbitrary Swarm hash
status Check API availability and Bee compatibility
hash Print the Swarm hash of a file
status Check Bee status
addresses Display the addresses of the Bee node
stake Manages nodes stake
Run 'swarm-cli COMMAND --help' for more information on a command
```
Expand Down

0 comments on commit d3cd5a0

Please sign in to comment.