Skip to content

Commit 40e7140

Browse files
authored
Edits to MacOS section of Kubo cmd line install instructions (#1289)
* Edits to MacOS section of Kubo cmd line install instructions * Address TMos review, minus a few things * Address #1289 (comment) * Bolding, substeps * Fix some links * trigger rebuild * Fix dum merge conflict that I didn't notice, was causing build failure * remove mentions of v0.15.0 in mac cmd install instructions * jk, missed a few mentions of v0.15.0
1 parent 0ac03f9 commit 40e7140

File tree

1 file changed

+44
-15
lines changed

1 file changed

+44
-15
lines changed

docs/install/command-line.md

Lines changed: 44 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -89,43 +89,72 @@ The IPFS team manages the [dist.ipfs.tech website](https://dist.ipfs.tech/) to h
8989

9090
### macOS
9191

92-
:::tip M1-based Macs
93-
You can install IPFS on M1-based Macs by using the `darwin-arm64` binary instead of the `amd64` binary listed in these instructions.
94-
:::
92+
1. Decide which macOS binary to download from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo) by determining whether your system uses an Apple or Intel CPU. On most macOS systems, you can determine the system specs by doing the following:
9593

96-
1. Download the macOS binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
94+
1. In the upper left hand corner of your screen, click the "Apple" icon.
95+
1. In the drop-down menu displayed, select *About this Mac*.
96+
1. A window with information about your Mac is displayed.
97+
- If your system uses Apple Silicon, the specific chip is shown, such as *Apple M1 Pro*.
98+
- If your system uses an Intel CPU, the specific processor is shown, such as *2.3 GHz 8-Core Intel Core i9*.
99+
100+
101+
1. Download the appropriate macOS binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo) based on your hardware. For example:
97102

98103
```bash
99104
curl -O https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_darwin-amd64.tar.gz
100105
```
101106

102-
1. Unzip the file:
107+
> :warning:
108+
> Ensure that you download and install the appropriate binary, as the binary for an Intel-based system will not work on a system with Apple Silicon, and vice-versa.
109+
110+
- *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:
111+
```bash
112+
curl -O https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_darwin-arm64.tar.gz
113+
```
114+
115+
- *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:
116+
```bash
117+
curl -O https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_darwin-amd64.tar.gz
118+
```
119+
120+
1. Unzip the file. For example, to unzip `Kubo v0.17.0` for an Intel-based system:
103121

104122
```bash
105123
tar -xvzf kubo_v0.17.0_darwin-amd64.tar.gz
124+
```
106125

107-
> x kubo/install.sh
108-
> x kubo/ipfs
109-
> x kubo/LICENSE
110-
> x kubo/LICENSE-APACHE
111-
> x kubo/LICENSE-MIT
112-
> x kubo/README.md
126+
The following output displays:
127+
```
128+
x kubo/
129+
x kubo/ipfs
130+
x kubo/install.sh
113131
```
114132
115-
1. Move into the `kubo` folder and run the install script:
133+
1. Navigate to the `kubo` directory:
116134
117135
```bash
118136
cd kubo
137+
```
138+
139+
1. Run the install script:
140+
141+
```bash
119142
sudo bash install.sh
143+
```
120144

145+
On successful install, the following displays:
146+
```
121147
> Moved ./ipfs to /usr/local/bin
122148
```
123149

124-
1. Check that IPFS installed:
150+
1. Confirm that IPFS is installed:
125151

126152
```bash
127153
ipfs --version
154+
```
128155

156+
If IPFS is installed, the IPFS version number is displayed. For example:
157+
```
129158
> ipfs version 0.17.0
130159
```
131160

@@ -178,11 +207,11 @@ The command line can detect and use any node that's running, unless it's configu
178207

179208
### Local daemon
180209

181-
The local daemon process is automatically started in the CLI with the command `ipfs daemon`. It creates an `$IPFS_PATH/api` file with an [RPC API](./reference/kubo/rpc/#http-rpc-api-reference) address.
210+
The local daemon process is automatically started in the CLI with the command `ipfs daemon`. It creates an `$IPFS_PATH/api` file with an [RPC API](../reference/kubo/rpc.md#http-rpc-api-reference) address.
182211

183212
### Remote client
184213

185-
You can install the standalone IPFS CLI client independently and use it to talk to an IPFS Desktop node or a Brave node. Use the [RPC API](./reference/kubo/rpc/#http-rpc-api-reference) to talk to the `ipfs` daemon.
214+
You can install the standalone IPFS CLI client independently and use it to talk to an IPFS Desktop node or a Brave node. Use the [RPC API](../reference/kubo/rpc.md#http-rpc-api-reference) to talk to the `ipfs` daemon.
186215

187216
When an IPFS command is executed without parameters, the CLI client checks whether the `$IPFS_PATH/api` file exists and connects to the address listed there.
188217

0 commit comments

Comments
 (0)