Skip to content

Commit 1efafc5

Browse files
authored
fix(docs): devel README instructions (#481)
Signed-off-by: Fabián Ezequiel Gallina <[email protected]>
1 parent 6a933de commit 1efafc5

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

devel/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,21 @@ For development, Chainloop components (Control Plane, Artifact CAS and CLI) come
66

77
![development environment](../docs/img/dev-env-overview.png)
88

9-
### 1 - Prerequisites
9+
### 0 - Prerequisites
1010

1111
To get up and running you'll need
1212

1313
- Golang 1.20+ toolchain
1414
- [Docker Compose](https://docs.docker.com/compose/)
15-
- `make` (optional)
15+
- `make`
16+
17+
### 1 - Initialize your environment
18+
19+
This will download and install the CLI tools required to work with our code.
20+
21+
```sh
22+
make init
23+
```
1624

1725
### 2 - Run pre-required/auxiliary services
1826

@@ -60,7 +68,7 @@ You should now be ready to authenticate the CLI
6068
> NOTE: In development a `--insecure` flag must be provided to talk to the local APIs
6169
6270
```
63-
go run --insecure app/cli/main.go auth login
71+
go run app/cli/main.go --insecure auth login
6472
```
6573

6674
You will get redirected to the pre-configured local OIDC provider (DEX) where there are two configured users
@@ -111,4 +119,4 @@ Running the following command fixes the issue:
111119

112120
```
113121
sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock
114-
```
122+
```

0 commit comments

Comments
 (0)