Skip to content

Commit

Permalink
update holonix commands to get recommended version
Browse files Browse the repository at this point in the history
  • Loading branch information
pdaoust committed Nov 13, 2024
1 parent 85555fd commit 29482fd
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions src/pages/get-started/install-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,22 @@ If you want to learn more about how this setup works and how to create it manual
The flake-based one-liner to get you an ad-hoc Holonix shell looks like this:

```shell
nix develop github:holochain/holonix
nix develop github:holochain/holonix?ref=main-0.3
```

The above one-liner will give you the latest version of Holochain from branch `main`. To get an ad-hoc shell with a specific version of Holochain, use the flag `--override-input versions <version_path>`.
The above one-liner will give you the latest version of the **recommended** Holochain 0.3 release branch. To get an ad-hoc shell with a specific version of Holochain, change the `ref` parameter, for example:

```shell
nix develop --override-input holochain "github:holochain/holochain?ref=main-0.4" github:holochain/holonix
nix develop github:holochain/holonix?ref=main-0.4
```

The options you should know about are:

* `main` or no `ref` parameter: Bleeding-edge development version of Holochain (currently 0.5)
* `main-0.4`: RC of Holochain 0.4 (be aware that many breaking changes are coming in the next RC)
* `main-0.3`: The current recommended version of Holochain for everyday development
* `main-0.2`: An older version of Holochain, no longer recommended

### A gotcha with Flakes and Git

The behavior of `nix` commands that rely on a `flake.nix` as its input such as `nix develop` can be counterintuitive in a git repository.
Expand Down

0 comments on commit 29482fd

Please sign in to comment.