https://github.com/docker/node-sdk

Docker CLI gRPC JavaScript SDK
https://github.com/docker/node-sdk

docker javascript nodejs sdk

Last synced: 8 days ago
JSON representation

Docker CLI gRPC JavaScript SDK

• Host: GitHub
• URL: https://github.com/docker/node-sdk
• Owner: docker
• License: apache-2.0
• Created: 2020-06-09T10:23:29.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T20:19:43.000Z (4 months ago)
• Last Synced: 2024-09-22T14:01:11.495Z (13 days ago)
• Topics: docker, javascript, nodejs, sdk
• Language: JavaScript
• Homepage:
• Size: 919 KB
• Stars: 112
• Watchers: 10
• Forks: 49
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Docker CLI JavaScript SDK

![CI](https://github.com/docker/node-sdk/workflows/CI/badge.svg)

This repository contains the source for the Node SDK to work with the

experimental Docker command line for Azure integration. The SDK is available as

an [npm package](https://www.npmjs.com/package/@docker/sdk)

> :warning: This SDK is in beta, expect things to change or break!

## Getting started

Add `@docker/sdk` to the dependencies

```console

yarn add @docker/sdk

```

You can then use the SDK:

```typescript

// import the contexts client

import { Contexts } from '@docker/sdk';

// import request and response classes

import { ListRequest, ListResponse } from '@docker/sdk/contexts';

const client = new Contexts();

// Get the list of contexts

client.list(new ListRequest(), (err: any, resp: ListResponse) => {

  if (err) {

    console.error(err);

    return;

  }

  const contexts = resp.getContextsList().map((c) => c.getName());

  console.log(contexts);

});

```

When you run this code you should see a list of contexts, for example:

```console

$ ts-node example.ts

aci-context

default

```

## Examples

You can find examples for how to use this SDK in the [examples](./examples)

directory.