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
+28-28Lines changed: 28 additions & 28 deletions
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.17.0
4
+
current-ipfs-version: v0.18.0
5
5
---
6
6
7
7
# Install IPFS Kubo
@@ -31,13 +31,13 @@ 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.17.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.18.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
35
35
36
36
### Kubo on resource-constrained systems
37
37
38
38
If you are running Kubo on a resource-constrained system (such as a Raspberry Pi), you should complete the following steps:
39
39
40
-
1. Install OpenSSL and rebuild Kubo manually with `make build GOTAGS=openssl`. See the [download and compile](https://github.com/ipfs/kubo/blob/v0.17.0/README.md#download-and-compile-ipfs) section for more information on compiling Kubo.
40
+
1. Install OpenSSL and rebuild Kubo manually with `make build GOTAGS=openssl`. See the [download and compile](https://github.com/ipfs/kubo/blob/v0.18.0/README.md#download-and-compile-ipfs) section for more information on compiling Kubo.
41
41
1. Initialize your daemon with the `lowpower` profile. This reduces daemon overhead on the system but may degrade performance of content discovery and data fetching.
42
42
43
43
```bash
@@ -73,27 +73,27 @@ For installation instructions for your operating system, select the appropriate
73
73
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.
168
168
169
-
-_If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.17.0` for an Apple-based system, run the following command:
169
+
-_If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.18.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.17.0`for an Intel-based system, run the following command:
175
+
- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for`Kubo v0.18.0`for an Intel-based system, run the following command:
@@ -360,7 +360,7 @@ For installation instructions for your operating system, select the appropriate
360
360
```bash
361
361
ipfs --version
362
362
363
-
> ipfs version 0.17.0
363
+
> ipfs version 0.18.0
364
364
```
365
365
366
366
:::
@@ -372,7 +372,7 @@ For installation instructions for your operating system, select the appropriate
372
372
373
373
## Build Kubo from source
374
374
375
-
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.17.0/README.md#build-from-source) section in the Kubo repository.
375
+
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.18.0/README.md#build-from-source) section in the Kubo repository.
376
376
377
377
## Determining which node to use with the command line
Copy file name to clipboardExpand all lines: docs/reference/kubo/cli.md
+31-40Lines changed: 31 additions & 40 deletions
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,22 @@ description: API documentation for the Kubo command-line executable.
5
5
6
6
# Kubo command-line
7
7
8
-
::: tip Generated on 2022-11-22 16:36:20, from kubo 0.17.0
9
-
This document was autogenerated from CLI help text in [kubo 0.17.0](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
8
+
::: tip Generated on 2023-01-24 05:33:54, from kubo 0.18.0
9
+
This document was autogenerated from CLI help text in [kubo 0.18.0](https://github.com/ipfs/kubo/releases/tag/v0.18.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
13
13
<!-- DO NOT EDIT THIS FILE. This file is auto-generated from `generate-cli-docs.sh`. Any changes you make to this file will be overwritten. To edit this file, change the contents of the `generate-cli-docs.sh` script. -->
14
14
15
15
IPFS can run in either _online_ or _offline_ mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like `ipfs swarm peers`, are only supported when online.
16
16
17
-
The [command-line quickstart guide](../../how-to/command-line-quick-start.md#take-your-node-online) explains how to start the IPFS daemon and take your node online.
17
+
The [command-line quickstart guide](/how-to/command-line-quick-start/#take-your-node-online) explains how to start the IPFS daemon and take your node online.
18
18
19
19
20
20
21
21
### Alignment with Kubo RPC API
22
22
23
-
Every command usable from the CLI is also available through the [RPC API v0](../../reference/kubo/rpc.md). For example:
23
+
Every command usable from the CLI is also available through the [RPC API v0](/reference/kubo/rpc). For example:
24
24
25
25
```sh
26
26
> ipfs swarm peers
@@ -1044,16 +1044,6 @@ SYNOPSIS
1044
1044
DESCRIPTION
1045
1045
1046
1046
Available profiles:
1047
-
'server':
1048
-
Disables local host discovery, recommended when
1049
-
running IPFS on machines with public IPv4 addresses.
1050
-
'default-datastore':
1051
-
Configures the node to use the default datastore (flatfs).
1052
-
1053
-
Read the "flatfs" profile description for more information on this datastore.
1054
-
1055
-
This profile may only be applied when first initializing the node.
1056
-
1057
1047
'flatfs':
1058
1048
Configures the node to use the flatfs datastore.
1059
1049
@@ -1070,15 +1060,6 @@ DESCRIPTION
1070
1060
1071
1061
This profile may only be applied when first initializing the node.
1072
1062
1073
-
'local-discovery':
1074
-
Sets default values to fields affected by the server
1075
-
profile, enables discovery in local networks.
1076
-
'test':
1077
-
Reduces external interference of IPFS daemon, this
1078
-
is useful when using the daemon in test environments.
1079
-
'default-networking':
1080
-
Restores default network settings.
1081
-
Inverse profile of the test profile.
1082
1063
'badgerds':
1083
1064
Configures the node to use the experimental badger datastore.
1084
1065
@@ -1104,6 +1085,25 @@ DESCRIPTION
1104
1085
1105
1086
'randomports':
1106
1087
Use a random port number for swarm.
1088
+
'local-discovery':
1089
+
Sets default values to fields affected by the server
1090
+
profile, enables discovery in local networks.
1091
+
'test':
1092
+
Reduces external interference of IPFS daemon, this
1093
+
is useful when using the daemon in test environments.
1094
+
'default-networking':
1095
+
Restores default network settings.
1096
+
Inverse profile of the test profile.
1097
+
'default-datastore':
1098
+
Configures the node to use the default datastore (flatfs).
1099
+
1100
+
Read the "flatfs" profile description for more information on this datastore.
1101
+
1102
+
This profile may only be applied when first initializing the node.
1103
+
1104
+
'server':
1105
+
Disables local host discovery, recommended when
1106
+
running IPFS on machines with public IPv4 addresses.
1107
1107
1108
1108
SUBCOMMANDS
1109
1109
ipfs config profile apply <profile> - Apply profile to config.
0 commit comments