Skip to content

Commit

Permalink
mac os instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
shawntabrizi committed Aug 8, 2024
1 parent 5df81d2 commit b07efd6
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,27 @@ Zombienet releases are available in `github`. Each one provides an executable fo
**Note:** Currently, it is only possible to use `podman` for Zombienet users on Linux machines.
Although `podman` comes with support for macOS, it is done using an internal VM and the Zombienet provider code expects `podman` to be running natively.

### Using Binaries on MacOS

After you have downloaded `zombienet-macos-arm64` or `zombienet-macos-x64`, you will need to:

- Move the binary to your working directory.
- Rename the binary to just `zombienet` without any `macos-<version>` extension for convenience.
- Enable the binary to be executable:
```bash
chmod +x ./zombienet
```
- Remove the binary from quarantine:
```bash
xattr -d com.apple.quarantine ./zombienet
```

Then you should be able to access the binary:

```bash
./zombienet help
```

### Install from NPM

If you have `Node.js`, you can install `zombienet` locally via NPM:
Expand Down
21 changes: 21 additions & 0 deletions docs/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

ZombieNet releases are available in [github](https://github.com/paritytech/zombienet/releases). Each release provides executables for both `linux` and `macos` created with [pkg](https://github.com/vercel/pkg) and allows running `zombienet` cli *without* having `Node.js` installed. **But** each `provider` define its own requirements (e.g. k8s, podman).

## Using Binaries on MacOS

After you have downloaded `zombienet-macos-arm64` or `zombienet-macos-x64`, you will need to:

- Move the binary to your working directory.
- Rename the binary to just `zombienet` without any `macos-<version>` extension for convenience.
- Enable the binary to be executable:
```bash
chmod +x ./zombienet
```
- Remove the binary from quarantine:
```bash
xattr -d com.apple.quarantine ./zombienet
```

Then you should be able to access the binary:

```bash
./zombienet help
```

## Using NPM

If you have `Node.js`, you can install `zombienet` locally via NPM:
Expand Down

0 comments on commit b07efd6

Please sign in to comment.