Docker CLI gRPC JavaScript SDK
Перейти к файлу
Guillaume Tardif 2f9feb7009
Merge pull request #36 from gtardif/fix_download
Fix downloading the cli and extract tar.gz
2020-09-24 14:52:19 +02:00
.github/workflows Name the release workflow (nicer display in GH UI) 2020-09-14 15:35:59 +02:00
examples Add example for start/stop 2020-08-13 16:15:40 +02:00
scripts Fix downloading the cli and extract tar.gz 2020-09-24 14:46:20 +02:00
src Rename docker/api -> docker/compose-cli 2020-08-18 16:57:14 +02:00
test Fix downloading the cli and extract tar.gz 2020-09-24 14:46:20 +02:00
.dockerignore Containerize proto generation and test 2020-08-17 10:48:01 +02:00
.eslintrc.js Add eslint config 2020-06-09 18:26:54 +02:00
.gitignore gitignore: Add build artifacts 2020-08-18 16:44:48 +02:00
Dockerfile Containerize build and lint 2020-08-18 16:44:45 +02:00
LICENSE Add license 2020-07-06 15:41:19 +02:00
Makefile Containerize build and lint 2020-08-18 16:44:45 +02:00
NOTICE Add license 2020-07-06 15:41:19 +02:00
README.md Remove unused dependecies 2020-07-08 14:45:43 +02:00
babel.config.js Add exec example 2020-06-12 15:41:56 +02:00
package.json Fix downloading the cli and extract tar.gz 2020-09-24 14:46:20 +02:00
protos.sh Initial commit 2020-06-09 13:08:34 +02:00
publish.sh Automatically publish tagged packages (on tags v*) 2020-09-14 15:12:55 +02:00
tsconfig.json Add publish.sh script to publish on npm 2020-07-07 10:04:09 +02:00
yarn.lock Fix downloading the cli and extract tar.gz 2020-09-24 14:46:20 +02:00

README.md

Docker CLI JavaScript SDK

CI

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

⚠️ This SDK is in beta, expect things to change or break!

Getting started

Add @docker/sdk to the dependencies

yarn add @docker/sdk

You can then use the SDK:

// 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:

$ ts-node example.ts
aci-context
default

Examples

You can find examples for how to use this SDK in the examples directory.