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/reference/cli.md
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ description: API documentation for the Go-IPFS command-line executable.
7
7
8
8
<!-- 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. -->
9
9
10
-
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. 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.
10
+
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. 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.
11
11
12
12
13
13
14
14
### Alignment with HTTP API
15
15
16
-
Every command usable from the CLI is also available through the [HTTP API](http/api.md). For example:
16
+
Every command usable from the CLI is also available through the [HTTP API](/reference/http/api). For example:
17
17
18
18
```sh
19
19
> ipfs swarm peers
@@ -32,7 +32,7 @@ Every command usable from the CLI is also available through the [HTTP API](http/
32
32
```
33
33
34
34
35
-
_Generated on 2021-06-23 12:01:39, from go-ipfs 0.9.0._
35
+
_Generated on 2021-09-20 21:03:27, from go-ipfs 0.9.1._
36
36
37
37
## ipfs
38
38
@@ -891,29 +891,24 @@ SYNOPSIS
891
891
DESCRIPTION
892
892
893
893
Available profiles:
894
-
'server':
895
-
Disables local host discovery, recommended when
896
-
running IPFS on machines with public IPv4 addresses.
897
-
'local-discovery':
898
-
Sets default values to fields affected by the server
899
-
profile, enables discovery in local networks.
900
-
'test':
901
-
Reduces external interference of IPFS daemon, this
902
-
is useful when using the daemon in test environments.
903
894
'default-datastore':
904
895
Configures the node to use the default datastore (flatfs).
905
896
906
897
Read the "flatfs" profile description for more information on this datastore.
907
898
908
899
This profile may only be applied when first initializing the node.
909
900
910
-
'lowpower':
911
-
Reduces daemon overhead on the system. May affect node
912
-
functionality - performance of content discovery and data
913
-
fetching may be degraded.
914
-
915
901
'randomports':
916
902
Use a random port number for swarm.
903
+
'server':
904
+
Disables local host discovery, recommended when
905
+
running IPFS on machines with public IPv4 addresses.
906
+
'local-discovery':
907
+
Sets default values to fields affected by the server
908
+
profile, enables discovery in local networks.
909
+
'test':
910
+
Reduces external interference of IPFS daemon, this
911
+
is useful when using the daemon in test environments.
917
912
'default-networking':
918
913
Restores default network settings.
919
914
Inverse profile of the test profile.
@@ -949,6 +944,11 @@ DESCRIPTION
949
944
* This datastore uses up to several gigabytes of memory.
950
945
951
946
This profile may only be applied when first initializing the node.
947
+
'lowpower':
948
+
Reduces daemon overhead on the system. May affect node
949
+
functionality - performance of content discovery and data
950
+
fetching may be degraded.
951
+
952
952
953
953
SUBCOMMANDS
954
954
ipfs config profile apply <profile> - Apply profile to config.
Copy file name to clipboardExpand all lines: docs/reference/http/api.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ description: HTTP API reference for IPFS, the InterPlanetary File System.
9
9
<!-- TODO: Describe how to change ports and configure the API server -->
10
10
<!-- TODO: Structure this around command groups (dag, object, files, etc.) -->
11
11
12
-
_Generated on 2021-06-23, from go-ipfs v0.9.0._
12
+
_Generated on 2021-09-20, from go-ipfs v0.9.1._
13
13
14
14
When an IPFS node is running as a daemon, it exposes an HTTP API that allows you to control the node and run the same commands you can from the command line.
15
15
@@ -55,7 +55,7 @@ Arguments are added through the special query string key "arg":
55
55
}
56
56
```
57
57
58
-
Note that it can be used multiple times to signify multiple arguments. Boolean `bool` values may have the value `true` or `false`.
58
+
Note that it can be used multiple times to signify multiple arguments.
59
59
60
60
### Flags
61
61
@@ -739,7 +739,7 @@ Format and convert a CID in various useful ways.
739
739
### Arguments
740
740
741
741
-`arg`[string]: Cids to format. Required: **yes**.
0 commit comments