summaryrefslogtreecommitdiff
path: root/docs/src/api/codeexamples.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/api/codeexamples.md')
-rw-r--r--docs/src/api/codeexamples.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/src/api/codeexamples.md b/docs/src/api/codeexamples.md
new file mode 100644
index 0000000..b3bcdc3
--- /dev/null
+++ b/docs/src/api/codeexamples.md
@@ -0,0 +1,16 @@
+# Code examples
+This chapter contains code examples that use the API
+
+## Go command line client
+The following is an example [in the repository](https://github.com/eduvpn/eduvpn-common/blob/v2/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}}
+```