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
+27-27Lines changed: 27 additions & 27 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.21.0
4
+
current-ipfs-version: v0.22.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.21.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.22.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
35
35
36
36
### Kubo on resource-constrained systems
37
37
@@ -72,27 +72,27 @@ For installation instructions for your operating system, select the appropriate
72
72
1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
> Ensure that you download and install the appropriate binary, as the binary for an Intel-based system won't work on a system with Apple Silicon, and vice-versa.
167
167
168
-
-_If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.21.0` for an Apple-based system, run the following command:
168
+
-_If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.22.0` for an Apple-based system, run the following command:
- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for`Kubo v0.21.0`for an Intel-based system, run the following command:
174
+
- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for`Kubo v0.22.0`for an Intel-based system, run the following command:
@@ -359,7 +359,7 @@ For installation instructions for your operating system, select the appropriate
359
359
```bash
360
360
ipfs --version
361
361
362
-
> ipfs version 0.21.0
362
+
> ipfs version 0.22.0
363
363
```
364
364
365
365
:::
@@ -371,7 +371,7 @@ For installation instructions for your operating system, select the appropriate
371
371
372
372
## Build Kubo from source
373
373
374
-
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.21.0/README.md#build-from-source) section in the Kubo repository.
374
+
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.22.0/README.md#build-from-source) section in the Kubo repository.
375
375
376
376
## Determining which node to use with the command line
Copy file name to clipboardExpand all lines: docs/reference/kubo/cli.md
+40-32Lines changed: 40 additions & 32 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 2023-07-03 11:11:30, from kubo 0.21.0
9
-
This document was autogenerated from CLI help text in [kubo 0.21.0](https://github.com/ipfs/kubo/releases/tag/v0.21.0)
8
+
::: tip Generated on 2023-08-09 15:18:37, from kubo 0.22.0
9
+
This document was autogenerated from CLI help text in [kubo 0.22.0](https://github.com/ipfs/kubo/releases/tag/v0.22.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
@@ -1044,12 +1044,14 @@ SYNOPSIS
1044
1044
DESCRIPTION
1045
1045
1046
1046
Available profiles:
1047
+
'randomports':
1048
+
Use a random port number for swarm.
1047
1049
'server':
1048
1050
Disables local host discovery, recommended when
1049
1051
running IPFS on machines with public IPv4 addresses.
1050
-
'test':
1051
-
Reduces external interference of IPFS daemon, this
1052
-
is useful when using the daemon in test environments.
1052
+
'local-discovery':
1053
+
Sets default values to fields affected by the server
1054
+
profile, enables discovery in local networks.
1053
1055
'default-networking':
1054
1056
Restores default network settings.
1055
1057
Inverse profile of the test profile.
@@ -1060,6 +1062,22 @@ DESCRIPTION
1060
1062
1061
1063
This profile may only be applied when first initializing the node.
1062
1064
1065
+
'flatfs':
1066
+
Configures the node to use the flatfs datastore.
1067
+
1068
+
This is the most battle-tested and reliable datastore.
1069
+
You should use this datastore if:
1070
+
1071
+
* You need a very simple and very reliable datastore, and you trust your
1072
+
filesystem. This datastore stores each block as a separate file in the
1073
+
underlying filesystem so it's unlikely to loose data unless there's an issue
1074
+
with the underlying file system.
1075
+
* You need to run garbage collection in a way that reclaims free space as soon as possible.
1076
+
* You want to minimize memory usage.
1077
+
* You are ok with the default speed of data import, or prefer to use --nocopy.
1078
+
1079
+
This profile may only be applied when first initializing the node.
1080
+
1063
1081
'badgerds':
1064
1082
Configures the node to use the experimental badger datastore.
1065
1083
@@ -1078,32 +1096,14 @@ DESCRIPTION
1078
1096
which is no longer supported by the upstream team.
1079
1097
1080
1098
This profile may only be applied when first initializing the node.
1081
-
'local-discovery':
1082
-
Sets default values to fields affected by the server
1083
-
profile, enables discovery in local networks.
1084
-
'flatfs':
1085
-
Configures the node to use the flatfs datastore.
1086
-
1087
-
This is the most battle-tested and reliable datastore.
1088
-
You should use this datastore if:
1089
-
1090
-
* You need a very simple and very reliable datastore, and you trust your
1091
-
filesystem. This datastore stores each block as a separate file in the
1092
-
underlying filesystem so it's unlikely to loose data unless there's an issue
1093
-
with the underlying file system.
1094
-
* You need to run garbage collection in a way that reclaims free space as soon as possible.
1095
-
* You want to minimize memory usage.
1096
-
* You are ok with the default speed of data import, or prefer to use --nocopy.
1097
-
1098
-
This profile may only be applied when first initializing the node.
1099
-
1100
1099
'lowpower':
1101
1100
Reduces daemon overhead on the system. May affect node
1102
1101
functionality - performance of content discovery and data
1103
1102
fetching may be degraded.
1104
1103
1105
-
'randomports':
1106
-
Use a random port number for swarm.
1104
+
'test':
1105
+
Reduces external interference of IPFS daemon, this
1106
+
is useful when using the daemon in test environments.
1107
1107
1108
1108
SUBCOMMANDS
1109
1109
ipfs config profile apply <profile> - Apply profile to config.
@@ -3320,7 +3320,7 @@ USAGE
3320
3320
ipfs name inspect <record> - Inspects an IPNS Record
3321
3321
3322
3322
SYNOPSIS
3323
-
ipfs name inspect [--verify=<verify>] [--] <record>
3323
+
ipfs name inspect [--verify=<verify>] [--dump=false] [--] <record>
3324
3324
3325
3325
ARGUMENTS
3326
3326
@@ -3329,6 +3329,8 @@ ARGUMENTS
3329
3329
OPTIONS
3330
3330
3331
3331
--verify string - CID of the public IPNS key to validate against.
3332
+
--dump bool - Include a full hex dump of the raw Protobuf record.
3333
+
Default: true.
3332
3334
3333
3335
DESCRIPTION
3334
3336
@@ -3356,7 +3358,8 @@ USAGE
3356
3358
SYNOPSIS
3357
3359
ipfs name publish [--resolve=false] [--lifetime=<lifetime> | -t]
-k, --key string - Name of the key to be used or a valid PeerID, as
3382
3385
listed by 'ipfs key list -l'. Default: self.
3383
3386
-Q, --quieter bool - Write only final hash.
3387
+
--v1compat bool - Produce a backward-compatible IPNS Record by
3388
+
including fields for both V1 and V2 signatures.
3389
+
Default: true.
3384
3390
--ipns-base string - Encoding used for keys: Can either be a multibase
3385
3391
encoded CID or a base58btc encoded multihash. Takes
3386
3392
{b58mh|base36|k|base32|b...}. Default: base36.
@@ -5554,7 +5560,7 @@ DESCRIPTION
5554
5560
SUBCOMMANDS
5555
5561
ipfs swarm addrs - List known addresses. Useful for
5556
5562
debugging.
5557
-
ipfs swarm connect <address>... - Open connection to a given address.
5563
+
ipfs swarm connect <address>... - Open connection to a given peer.
5558
5564
ipfs swarm disconnect <address>... - Close connection to a given address.
5559
5565
ipfs swarm filters - Manipulate address filters.
5560
5566
ipfs swarm peering - Modify the peering subsystem.
@@ -5633,7 +5639,7 @@ DESCRIPTION
5633
5639
5634
5640
```
5635
5641
USAGE
5636
-
ipfs swarm connect <address>... - Open connection to a given address.
5642
+
ipfs swarm connect <address>... - Open connection to a given peer.
5637
5643
5638
5644
SYNOPSIS
5639
5645
ipfs swarm connect [--] <address>...
@@ -5644,9 +5650,11 @@ ARGUMENTS
5644
5650
5645
5651
DESCRIPTION
5646
5652
5647
-
'ipfs swarm connect' opens a new direct connection to a peer address.
5653
+
'ipfs swarm connect' attempts to ensure a connection to a given peer.
5654
+
5655
+
Multiaddresses given are advisory, for example the node may already be aware of other addresses for a given peer or may already have an established connection to the peer.
0 commit comments