Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add go install instructions #190

Merged
merged 8 commits into from
Jan 22, 2025
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,29 @@ Also, only contracts inside foundry projects are supported as of now.

For development, we require [the `go` toolchain to be installed](https://go.dev/doc/install).

## How to install

### Using `go` toolchain

To install the devnet using the `go` toolchain:

```sh
go install github.com/Layr-Labs/avs-devnet/cmd/avs-devnet
```

> [!IMPORTANT]
> To be able to [install the CLI via `go`](#installation), you'll need to add `$HOME/go/bin` to your `PATH`.
> You can do so by adding to your `~/.bashrc` (or the equivalent for your shell) the following line:
> To be able to use the CLI when installed via `go`, you'll need to add `GOBIN` (by default `$HOME/go/bin`) to your `PATH`.
> You can do so by adding to your `~/.bashrc`, or the equivalent for your shell, the following line:
>
> ```bash
> export PATH="$PATH:$HOME/go/bin"
> ```
>
> More information [on the Go wiki](https://go.dev/wiki/GOPATH).

## Installation
### With a local copy of the repo

To build and install the CLI locally, run:
To build and install the CLI with a local copy of the repo, first clone the repo, and then run:

```sh
make deps # installs dependencies
Expand Down
2 changes: 1 addition & 1 deletion src/cmds/flags/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import "github.com/urfave/cli/v2"
// TODO: move to constants.
//
//nolint:gochecknoglobals // this is a constant
var DefaultKurtosisPackage string = ""
var DefaultKurtosisPackage string = "github.com/Layr-Labs/avs-devnet/kurtosis_package"

//nolint:gochecknoglobals // these are constants
var (
Expand Down
Loading