Skip to content

Commit c75cdfa

Browse files
committed
update swarm-cli page description
1 parent 102cb93 commit c75cdfa

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

docs/bee/working-with-bee/swarm-cli.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,33 @@ title: Swarm CLI
33
id: swarm-cli
44
---
55

6-
Swarm CLI is a command line based application which simplifies interactions with the Bee API. It allows you to accomplish most common tasks using easy to understand commands. It also greatly simplifies certain more complex tasks, such as as the management of [feeds](/docs/develop/tools-and-features/feeds).
6+
**Swarm‑CLI** is a command‑line tool powered by `bee-js` that makes it easy to interact with your Bee node directly from the command line. It’s friendlier than working with the raw Bee HTTP API and faster than writing a custom `bee-js` script when you just want to perform an action from the terminal.
7+
8+
:::tip
9+
`swarm-cli` is the recommended method for interaction with your Bee node from the command line. Unless you have explicit need to use the Bee API directly, `swarm-cli` is generally the better option.
10+
:::
11+
12+
Common uses:
13+
14+
* Check your node: `swarm-cli status`
15+
* Add stake:
16+
* Upload files or a static site: `swarm-cli upload <path>` (will prompt to pick or create a postage batch)
17+
* Download content: `swarm-cli download <reference> -o <output>`
18+
* Inspect and manage postage batches: `swarm-cli ...` (use `--help` to see stamp-related commands)
19+
20+
**Why use it?**
21+
22+
* **No scaffolding needed** — run direct commands without creating a project
23+
* **Interactive prompts** — it guides you through common tasks such as stamp purchasing and selection using interactive prompts
24+
* **Smart option inference** — it infers options based on your input (e.g., batch selection, index page, content type) so you don’t need deep Bee API knowledge
25+
* **Powered by `bee-js`** — stays aligned with the latest Bee features
26+
27+
It also greatly simplifies certain more complex tasks, such as as the management of [feeds](/docs/develop/tools-and-features/feeds).
728

829
For installation and usage instructions, [see the README](https://github.com/ethersphere/swarm-cli/blob/master/README.md).
930

1031
To check the latest version, see the Swarm CLI [releases page](https://github.com/ethersphere/swarm-cli/releases).
1132

12-
For further support and information, [join the Swarm Discord server](https://discord.com/invite/GU22h2utj6).
33+
For further support and information, [join the Swarm Discord server](https://discord.com/invite/GU22h2utj6).
34+
35+

0 commit comments

Comments
 (0)