README.md

sdk-go

The Ops Platform SDK for Go

Table of Contents

• sdk-go
  • Table of Contents
• Usage
  • Example sdk usage
  • Running inside an op
  • Documentation
  • Contributing
  • License

---

Usage

Example sdk usage

Documentation and example usage can be found in their respective source code.

package main

import (
	"fmt"
	"github.com/cto-ai/sdk-go"
	"log"
	"time"
)

func main() {
	// instantiate new CTO.ai client
	client := ctoai.NewClient()

	// printing text to interface
	err := client.Ux.Print("starting e2e test of Go SDK")
	if err != nil {
		log.Fatal(err)
	}

	// prompt user to confirm
	// captures user stdin and converts to a bool
	output, err := client.Prompt.Confirm("confirmation", "confirm?", ctoai.OptConfirmFlag("C"), ctoai.OptConfirmDefault(true))
	if err != nil {
		log.Fatal(err)
	}

	fmt.Printf("You confirmed with a %v\n", output)

	// displays a progress bar to the interface
	err = client.Ux.ProgressBarStart(5, 1, "Finishing...")
	if err != nil {
		log.Fatal(err)
	}

	// do some work
	time.Sleep(2 * time.Second)

	err = client.Ux.ProgressBarAdvance(4)
	if err != nil {
		log.Fatal(err)
	}

	err = client.Ux.ProgressBarStop("Done!")
	if err != nil {
		log.Fatal(err)
	}
}

Running inside an op

This uses the example code above.

############################
# Build container
############################
FROM golang:1.13.6 AS build

WORKDIR /ops

ADD . .

RUN go build -ldflags="-s -w" -o main

############################
# Final container
############################
FROM registry.cto.ai/official_images/base:latest

COPY --from=build /ops/main /ops/main

Corresponding ops.yml run command:

run: /ops/main

Documentation

• You can find the CTO.ai Go SDK documentation on the docs website

Contributing

The main aim of this repository is to continue developing and advancing CTO.ai Go, making it faster and more simplified to use. Kindly check our contributing guide on how to propose bug fixes and improvements, as well as submit pull requests to the project.

License

© Hack Capital Ventures, Inc., 2022

Distributed under MIT License (The MIT License).

See LICENSE for more information.