Skip to content

IBM/code-engine-go-sdk

Repository files navigation

Build Status

semantic-release

IBM Cloud Code Engine Go SDK 4.14.1

Go client library to interact with the Code Engine API.

Table of Contents

Overview

The IBM Cloud Code Engine Go SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name Package name
Code Engine codeenginev2
Code Engine ibmcloudcodeenginev1

Prerequisites

  • An IBM Cloud account.
  • An IAM API key to allow the SDK to access your account. Create one here.
  • Go version 1.21 or above.

Installation

The current version of this SDK: 4.14.1

There are a few different ways to download and install the Code Engine Go SDK project for use by your Go application:

go get command

Use this command to download and install the SDK to allow your Go application to use it:

go get -u github.com/IBM/code-engine-go-sdk

Go modules

If your application is using Go modules, you can add a suitable import to your Go application, like this:

import (
	"github.com/IBM/code-engine-go-sdk/codeenginev2"
)

then run go mod tidy to download and install the new dependency and update your Go application's go.mod file.

dep dependency manager

If your application is using the dep dependency management tool, you can add a dependency to your Gopkg.toml file. Here is an example:

[[constraint]]
  name = "github.com/IBM/code-engine-go-sdk"
  version = "4.14.1"

then run dep ensure.

Using the SDK

Examples are available here.

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.