ADCS CLI Reference
ADCS (Kubo) Command-Line Interface Reference
This document serves as the authoritative reference guide for the Autheo Decentralized Cloud Storage (ADCS) Command-Line Interface (CLI). It provides detailed syntax, arguments, flags, and usage examples for every available ADCS command, enabling users to manage their node, interact with content, and administer the network environment efficiently.
Table of contents
-
ADCS command-line interface
-
adcs (Global command)
2.1. Usage and synopsis
2.2. Options
2.3. Exit status
-
Basic commands
3.1. adcs init
3.2. adcs add
3.3. adcs cat
3.4. adcs get
3.5. adcs ls
3.6. adcs refs
-
Data structure commands
4.1. adcs dag (IPLD DAG nodes)
4.2. adcs files (Files API)
4.3. adcs block (Blockstore)
-
Text encoding commands
5.1. adcs cid
5.2. adcs multibase
-
Advanced commands
6.1. adcs daemon
6.2. adcs shutdown
6.3. adcs resolve
6.4. adcs name (IPNS)
6.5. adcs key
6.6. adcs pin
6.7. adcs repo
6.8. adcs stats
6.9. adcs mount
6.10. adcs filestore
-
Network commands
7.1. adcs id
7.2. adcs bootstrap
7.3. adcs swarm
7.4. adcs dht
7.5. adcs bitswap
7.6. adcs pubsub
7.7. adcs ping
7.8. adcs routing
-
Tool commands
8.1. adcs config
8.2. adcs version
8.3. adcs diag
8.4. adcs update
8.5. adcs commands
8.6. adcs log
1. ADCS command-line interface
The ADCS (Kubo) command-line interface is generated from kubo 0.35.0 (as of 2025-07-01).
ADCS can run in either online or offline mode:
-
Online mode: Requires the
ADCS daemonto be running as a separate background process. -
Offline mode: Commands that do not require network connectivity are available without a running daemon.
Use adcs <command> --help to view detailed usage and subcommands for any command.
2. adcs (Global command)
adcs is the global command for the p2p merkle-dag filesystem.
2.1. Usage and synopsis
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs [--config=<config> | -c] [--debug | -D] [--help | -h] [--api=<api>] [--offline] [--cid-base=<base>] [--upgrade-cidv0-in-output] [--encoding=<encoding> | --enc] [--timeout=<timeout>] <command> [<args>]
2.2. Options
| Option | Description |
--repo-dir string |
Path to the repository directory (default: ~/.adcs). |
--config-file string |
Path to the config file (default: $REPO/config). |
-c, --config string |
[DEPRECATED] Alias for --config-file. |
-D, --debug |
Enable debug output. |
-h, --help |
Show full help text. |
--api string |
HTTP API endpoint (default: /ip4/127.0.0.1/tcp/5001). |
--offline |
Run in offline mode (no daemon required). |
--cid-base string |
Multibase encoding for version 1 CIDs (e.g., base32). |
--encoding string |
Output encoding format (text, json, xml). Default: text. |
--timeout duration |
Global timeout for commands (e.g., 30s). |
2.3. Exit status
-
0on success -
>0on error
3. Basic commands
3.1. adcs init
Initialize a new ADCS repository.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs init [--profile=<profile>] [--empty-repo] [--bits=<bits>] [--passphrase-file=<file>]
Options:
-
--profile: Predefined configuration profile (server,test,local).
Examples:
APPLY CODE BLOCK STYLE TO THE LINES BELOW:
adcs init --profile=server
adcs init --empty-repo --bits=4096
3.2. adcs add
Add files or directories to ADCS.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs add [--quiet] [--recursive] [--chunker=<strategy>] [--cid-version=<version>] [--inline] [--inline-limit=<size>] [<path>...]
3.3. adcs cat
Retrieve and output the data associated with a given object.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs cat <path>
3.4. adcs get
Download ADCS objects to disk.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs get [--output=<file>] <path>...
3.5. adcs ls
List links from an object.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs ls [--long] [--size] [--resolve-type] <path>...
3.6. adcs refs
List hashes of links from an object.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs refs [--format=<fmt>] [--edges] <path>...
4. Data structure commands
4.1. adcs dag (IPLD DAG nodes)
Interact with IPLD DAG nodes.
| Subcommand | Description | Example |
export <cid> |
Export DAG as UnixFS tar. | |
get <cid> |
Get raw multicodec data for a DAG node. | Apply Code Block: adcs dag get QmHash |
put [file]... |
Store data in the object store as raw nodes. | |
resolve <path> |
Resolve CID to a specific field or nested path. | |
stat <cid> |
Show statistics (links, size, blockcount). | Apply Code Block: adcs dag stat QmHash |
4.2. adcs files (Files API)
Operate on UnixFS files via the Files API.
| Subcommand | Description | Example |
ls <path> |
List directory entries. | Apply Code Block: adcs files ls /adcs/QmHash |
read <path> |
Read file data. | Apply Code Block: adcs files read /adcs/QmHash/file.txt |
write <path> |
Write data to a file (requires daemon). | |
rm <path> |
Remove a file or directory. | |
mkdir <path> |
Make a directory. | |
stat <path> |
Show file/directory metadata. |
4.3. adcs block (Blockstore)
Manage raw blocks in the blockstore.
| Subcommand | Description | Example |
get <cid> |
Get raw block data. | |
put file |
Store a block from file. | Apply Code Block: adcs block put --format=dag-pb file.bin |
rm <cid>... |
Remove blocks. | |
stat <cid> |
Show block size and metadata. | Apply Code Block: adcs block stat QmHash |
5. Text encoding commands
5.1. adcs cid
Convert and inspect CIDs.
| Subcommand | Description | Example |
base32 <cid> |
Convert CID to base32. |
Apply Code Block: adcs cid base32 QmHash |
decode <cid> |
Decode and print components. | Apply Code Block: adcs cid decode bafy...== |
prefix <cid> |
Show CID prefix information. |
5.2. adcs multibase
Encode/decode data using multibase.
| Subcommand | Description | Example |
encode <string> |
Encode string to multibase. | Apply Code Block: adcs multibase encode --base=base58btc "hello" |
decode <string> |
Decode a multibase string. | Apply Code Block: adcs multibase decode zQmHash |
6. Advanced commands
6.1. adcs daemon
Start the ADCS daemon.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs daemon [--enable-gc] [--routing=<type>] [--mount=<mountpoint>] [--key=<name>]
6.2. adcs shutdown
Shutdown the running daemon.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs shutdown
6.3. adcs resolve
Resolve ADCS paths across namespaces.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs resolve [--recursive] [--cid-base=<base>] <path>
6.4. adcs name (IPNS)
Manage IPNS records.
| Subcommand | Description | Example |
publish <path> |
Publish a name record. | Apply Code Block: adcs name publish --key=mykey /adcs/QmHash |
resolve <name> |
Resolve an IPNS name. |
Apply Code Block: adcs name resolve /ipns/QmPeerID |
6.5. adcs key
Manage keypairs for naming.
| Subcommand | Description |
gen <name> |
Generate a new key (rsa, ed25519). |
list |
List local keys. |
rename <old> <new> |
Rename a key. |
rm <name> |
Remove a key. |
6.6. adcs pin
Pin objects to persist locally.
| Subcommand | Description |
add <cid>... |
Pin objects. |
rm <cid>... |
Unpin objects. |
ls |
List pinned objects. |
6.7. adcs repo
Manage the local repository.
| Subcommand | Description |
stat |
Show repo statistics (size, GC status). |
gc |
Run garbage collection. |
version |
Show repo version. |
migrate |
Migrate repo to new format. |
6.8. adcs stats
Show operational statistics.
| Subcommand | Description |
bw |
Bandwidth usage. |
repo |
Repo disk usage. |
bitswap |
Bitswap peers and ledger. |
6.9. adcs mount
Mount an ADCS filesystem via FUSE.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs mount [--mountpoint=<path>]
6.10. adcs filestore
Manage the experimental filestore.
| Subcommand | Description |
ls |
List external files. |
mv <source> <dest> |
Move file into filestore. |
rm <file> |
Remove file from filestore. |
7. Network commands
7.1. adcs id
Show peer identity information.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs id [--peer=<id>]
7.2. adcs bootstrap
Manage bootstrap peers.
| Subcommand | Description |
add <addr>... |
Add bootstrap peers. |
rm <addr>... |
Remove peers. |
list |
Show current list. |
7.3. adcs swarm
Manage p2p connections.
| Subcommand | Description |
peers |
List connected peers. |
connect <addr> |
Open connection. |
disconnect <addr> |
Close connection. |
addrs |
Local listening addresses. |
filters |
Manage connection filters. |
7.4. adcs dht
Interact with the distributed hash table.
| Subcommand | Description |
findpeer <peerID> |
Find peer’s addresses. |
findprovs <cid> |
Find providers for a CID. |
provide <cid> |
Announce provision of content. |
get <key> |
Get value for DHT key. |
put <key> <value> |
Put value in DHT. |
7.5. adcs bitswap
Inspect Bitswap exchange.
| Subcommand | Description |
stat |
Bitswap statistics. |
ledger <peerID> |
Show ledger with peer. |
reprovide |
Reannounce all blocks. |
7.6. adcs pubsub
Publish/subscribe messaging system.
| Subcommand | Description |
subscribe <topic> |
Subscribe to a topic. |
publish <topic> <data> |
Publish data. |
ls |
List topics. |
peers <topic> |
List peers for a topic. |
7.7. adcs ping
Measure latency to a peer.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs ping <peerID> [--count=<n>]
7.8. adcs routing
Interact with the routing system.
| Subcommand | Description |
provide <cid> |
Announce content. |
resolve <name> |
Resolve name via routing. |
8. Tool commands
8.1. adcs config
Manage CLI config values.
| Subcommand | Description |
edit |
Open config in editor. |
replace <key> <value> |
Set a value. |
show |
Show current config. |
8.2. adcs version
Show version and dependencies.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs version [--check] [--deps]
8.3. adcs diag
Generate diagnostic reports.
| Subcommand | Description |
sysinfo |
System information. |
netstat |
Network connections. |
collect |
Gather logs and metrics. |
8.4. adcs update
Download and apply updates.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs update [--force] [--version=<ver>]
8.5. adcs commands
List available commands and shell completion.
APPLY CODE BLOCK STYLE TO THE LINE BELOW:
adcs commands [--completion]
8.6. adcs log
View and manage daemon logs.
| Subcommand | Description |
level <level> |
Set log verbosity (debug, info, warn). |
tail |
Continuously follow logs. |
ls |
List available log files. |