> For the complete documentation index, see [llms.txt](https://docs.zus.network/zus-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zus.network/zus-docs/clis/zboxcli.md).

# Zbox CLI

## Overview

The **zbox CLI** is the command-line interface for interacting with **Züs dStorage**.\
It provides developers and DevOps engineers with powerful commands to create allocations, upload and manage files, configure blobbers and validators, and handle token pools — all directly from the terminal.

zbox is built on top of the **Züs GoSDK** and is the primary tool for experimenting with and integrating Züs dStorage into applications.

### Key Capabilities

* **Storage Management**\
  Create and update allocations, list blobbers, transfer ownership, finalize, or cancel allocations.
* **File Operations**\
  Upload, download, update, delete, copy, move, and share files.\
  Support for **encrypted storage**, **public/private shares**, and **live feed uploads**.
* **Network & Configuration**\
  Inspect blobbers and validators, update their settings, and manage network configuration files (`config.yaml`, `network.yaml`).
* **Token Pools & Rewards**\
  Work with read, write, stake, and challenge pools.\
  Lock/unlock tokens, collect staking rewards, and query smart contract configurations.
* **Security Utilities**\
  Sign and decrypt data with wallet credentials, manage wallet keys, and enforce secure operations.

### When to Use zbox

* **Developers** prototyping apps that need secure, decentralized storage.
* **System administrators** managing blobber/validator settings.
* **Enterprise teams** integrating Züs into CI/CD pipelines or storage backends.
* **Power users** wanting full control over allocations, pools, and file-sharing.

***

### Documentation Structure

This CLI section is organized into the following parts:

1. **Installation & Getting Started**\
   How to install zbox, prerequisites, and first-time setup.
2. **Global Flags**\
   Parameters that apply across all commands.
3. **Creating & Managing Allocations**\
   Commands for allocation lifecycle (create, update, transfer, cancel, finalize).
4. **Uploading & Managing Files**\
   Commands for directories, upload/download, sharing, metadata, and repair.
5. **Wallet & Allocation Info**\
   Commands for retrieving wallet details, allocation info, and versioning.
6. **Token Pools & Staking**\
   Commands for read/write/stake/challenge pools and collecting rewards.
7. **Security & Utilities**\
   Commands for signing, decrypting, and managing configs.
8. **Troubleshooting**\
   Common issues, error resolution, and debugging.

***

### 🔗 Additional Resources

* [Züs GoSDK](https://github.com/0chain/gosdk)
* [zbox CLI Repository](https://github.com/0chain/zboxcli)

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.zus.network/zus-docs/clis/zboxcli.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.