Skip to content

Commit

Permalink
chore(docs): add build instructions to README (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
rhamzeh authored Jun 30, 2023
2 parents 8fd6093 + 6d76439 commit 022acfc
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,34 @@ fga query **expand** <relation> <object> [--contextual-tuple <user> <relation> <
}
```

## Building from Source

Make sure you have Go 1.20 or later installed. See the [Go downloads](https://go.dev/dl/) page.

1. Clone the repo to a local directory, and navigate to that directory:

```bash
git clone https://github.com/openfga/cli.git && cd cli
```

2. Then use the build command:

```bash
go build -o ./fga main.go
```

or if you have `make` installed, just run:

```bash
make
```

3. Run the OpenFGA CLI with:

```bash
./fga
```

## Contributing

See [CONTRIBUTING](https://github.com/openfga/.github/blob/main/CONTRIBUTING.md).
Expand Down

0 comments on commit 022acfc

Please sign in to comment.