You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install/command-line.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Kubo
3
3
description: Using IPFS Kubo through the command-line allows you to do everything that IPFS Desktop can do, but at a more granular level, since you can specify which commands to run. Learn how to install it here.
4
-
current-ipfs-version: v0.31.0
4
+
current-ipfs-version: v0.32.0
5
5
---
6
6
7
7
# Install IPFS Kubo
@@ -31,7 +31,7 @@ Kubo runs on most Windows, MacOS, Linux, FreeBSD and OpenBSD systems that meet t
31
31
32
32
Note the following:
33
33
- The amount of disk space your IPFS installation uses depends on how much data you're sharing. A base installation uses around 12MB of disk space.
34
-
- You can enable automatic garbage collection via [--enable-gc](../reference/kubo/cli.md#ipfs-daemon) and adjust using [default maximum disk storage](https://github.com/ipfs/kubo/blob/v0.31.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
34
+
- You can enable automatic garbage collection via [--enable-gc](../reference/kubo/cli.md#ipfs-daemon) and adjust using [default maximum disk storage](https://github.com/ipfs/kubo/blob/v0.32.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
35
35
36
36
37
37
<!-- TODO: hide this footgun until https://github.com/ipfs/kubo/pull/10524 is merged and released in stable kubo
@@ -76,27 +76,27 @@ For installation instructions for your operating system, select the appropriate
76
76
1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
@@ -310,7 +310,7 @@ For installation instructions for your operating system, select the appropriate
310
310
```bash
311
311
ipfs --version
312
312
313
-
> ipfs version 0.31.0
313
+
> ipfs version 0.32.0
314
314
```
315
315
316
316
:::
@@ -322,7 +322,7 @@ For installation instructions for your operating system, select the appropriate
322
322
323
323
## Build Kubo from source
324
324
325
-
For the current instructions on how to manually download, compile and build Kubo from source, see the [Build from Source](https://github.com/ipfs/kubo/blob/v0.31.0/README.md#build-from-source) section in the Kubo repository.
325
+
For the current instructions on how to manually download, compile and build Kubo from source, see the [Build from Source](https://github.com/ipfs/kubo/blob/v0.32.0/README.md#build-from-source) section in the Kubo repository.
326
326
327
327
## Determining which node to use with the command line
Copy file name to clipboardExpand all lines: docs/reference/kubo/cli.md
+54-54Lines changed: 54 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,8 @@ description: API documentation for the Kubo command-line executable.
5
5
6
6
# Kubo command-line
7
7
8
-
::: tip Generated on 2024-10-17 13:53:14, from kubo 0.31.0
9
-
This document was autogenerated from CLI help text in [kubo 0.31.0](https://github.com/ipfs/kubo/releases/tag/v0.31.0)
8
+
::: tip Generated on 2024-11-14 02:07:48, from kubo 0.32.0
9
+
This document was autogenerated from CLI help text in [kubo 0.32.0](https://github.com/ipfs/kubo/releases/tag/v0.32.0)
10
10
For issues and support, check out the [generate-cli-docs.sh](https://github.com/ipfs/ipfs-docs/blob/main/docs/reference/kubo/generate-cli-docs.sh) script on GitHub.
11
11
:::
12
12
@@ -1087,12 +1087,25 @@ SYNOPSIS
1087
1087
DESCRIPTION
1088
1088
1089
1089
Available profiles:
1090
-
'announce-on':
1091
-
Re-enables Reprovide system (reverts announce-off profile).
1092
-
'randomports':
1093
-
Use a random port number for swarm.
1094
-
'legacy-cid-v0':
1095
-
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
1090
+
'test':
1091
+
Reduces external interference of IPFS daemon, this
1092
+
is useful when using the daemon in test environments.
1093
+
'announce-off':
1094
+
Disables Reprovide system (and announcing to Amino DHT).
1095
+
1096
+
USE WITH CAUTION:
1097
+
The main use case for this is setups with manual Peering.Peers config.
1098
+
Data from this node will not be announced on the DHT. This will make
1099
+
DHT-based routing an data retrieval impossible if this node is the only
1100
+
one hosting it, and other peers are not already connected to it.
1101
+
1102
+
'default-datastore':
1103
+
Configures the node to use the default datastore (flatfs).
1104
+
1105
+
Read the "flatfs" profile description for more information on this datastore.
1106
+
1107
+
This profile may only be applied when first initializing the node.
1108
+
1096
1109
'pebbleds':
1097
1110
Configures the node to use the pebble high-performance datastore.
1098
1111
@@ -1112,49 +1125,28 @@ DESCRIPTION
1112
1125
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
1113
1126
via 'ipfs init --profile pebbleds'
1114
1127
1128
+
'lowpower':
1129
+
Reduces daemon overhead on the system. May affect node
1130
+
functionality - performance of content discovery and data
1131
+
fetching may be degraded.
1132
+
1115
1133
'test-cid-v1':
1116
1134
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
1117
1135
'server':
1118
1136
Disables local host discovery, recommended when
1119
1137
running IPFS on machines with public IPv4 addresses.
1120
-
'test':
1121
-
Reduces external interference of IPFS daemon, this
1122
-
is useful when using the daemon in test environments.
1123
-
'default-datastore':
1124
-
Configures the node to use the default datastore (flatfs).
1125
-
1126
-
Read the "flatfs" profile description for more information on this datastore.
1127
-
1128
-
This profile may only be applied when first initializing the node.
1129
-
1130
-
'badgerds':
1131
-
Configures the node to use the legacy badgerv1 datastore.
1132
-
1133
-
NOTE: this is badger 1.x, which has known bugs and is no longer supported by the upstream team.
1134
-
It is provided here only for pre-existing users, allowing them to migrate away to more modern datastore.
1135
-
1136
-
Other caveats:
1137
-
1138
-
* This datastore will not properly reclaim space when your datastore is
1139
-
smaller than several gigabytes. If you run IPFS with --enable-gc, you plan
1140
-
on storing very little data in your IPFS node, and disk usage is more
1141
-
critical than performance, consider using flatfs.
1142
-
* This datastore uses up to several gigabytes of memory.
1143
-
* Good for medium-size datastores, but may run into performance issues
0 commit comments