node-sdk/examples
Guillaume Tardif 368663ca7c Sync gRPC Compose API, added compose example
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-11-17 11:54:08 +01:00
..
README.md Add context create/use before running examples 2020-06-15 09:33:27 +02:00
compose.ts Sync gRPC Compose API, added compose example 2020-11-17 11:54:08 +01:00
context-ls.ts Adding sample code using context endpoints 2020-11-05 17:18:36 +01:00
exec.ts license: Update headers 2020-09-25 09:40:55 +02:00
ps.ts license: Update headers 2020-09-25 09:40:55 +02:00
start-stop.ts license: Update headers 2020-09-25 09:40:55 +02:00
volume.ts Add Volume management API & example 2020-09-29 11:25:01 +02:00

README.md

Examples

This folder contains examples of how to use the Docker CLI JavaScript SDK.

Prerequisites

To run the examples you will need to have an ACI context as default and the Docker CLI API server running. You can do this by running:

$ docker context create aci-context aci
$ docker context use aci-context
$ docker serve --address unix:///tmp/backend.sock

To make sure that you have the example dependencies installed, use:

$ yarn

Running examples

You can then run any an example from the root of this repository as follows:

$ npm run example examples/<file>

List of examples