summaryrefslogtreecommitdiff
path: root/docs/src/api/go/example.md
blob: a7f293bddfeb3b2cb2552f1a10b30869257ae739 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Example with comments
The following is an example [in the repository](https://github.com/eduvpn/eduvpn-common/blob/main/cmd/cli/main.go). It is a command line client with the following flags
```
  -get-custom string
        The url of a custom server to connect to
  -get-institute string
        The url of an institute to connect to
  -get-secure string
        Gets secure internet servers
```
```go
{{#include ../../../../cmd/cli/main.go}}
```

The documentation to then use this API is online at [pkg.go.dev](https://pkg.go.dev/github.com/eduvpn/eduvpn-common).

[We also provide an example](./example.md).