@linzjs/docker-command

@linzjs/docker-command

Run a command in either docker or on you local system

import { Command } from '@linzjs/docker-command';

const cmd = new Command('echo', { container: 'ubuntu', tag: 'latest' });

// Spawn a docker container and run `echo hello world`
await cmd.create().arg('Hello World').run(); // {stdout: "Hello World\n"}
// Spawn a echo process and run `echo hello world`
await cmd.create({ useDocker: false }).arg('Hello World').run(); // {stdout: "Hello World\n"}

Mounting folders in docker

folders can be mounted into the docker container volumes with .mount

.mount(path) will create a single --volume path:path

import { Command } from '@linzjs/docker-command';

const proc = await Command.create('ls', { container: 'ubuntu' });
proc.mount('/home/blacha');
proc.arg('/home/blacha');

await proc.run(); // ls results for local /home/blacha

Passing environment variables

import { Command } from '@linzjs/docker-command';

const proc = await Command.create('env', { container: 'ubuntu' });
proc.env('AWS_ACCESS_KEY_ID'); // Load process.env.AWS_ACCESS_KEY_ID into docker
proc.env('AWS_ACCESS_KEY_ID', 'fakeKey'); // set a specific AWS_ACCESS_KEY_ID into docker

Changelog

8.0.0 (2025-05-11)

Bug Fixes

• cli: update landing deploy script with new cli-config package BM-1260 (#3431) (4d7e86d), closes /github.com/linz/basemaps/blob/e527a04fec65c82f8577642493e8fcb475762243/packages/landing/scripts/deploy.mjs#L1
• ensure all linzjs packages are correctly labeled as deps (#3439) (de9df87), closes #3438
• ensure api key blocks are set in ci/cd (#3442) (28f6403)

Features

• cli-vector: Extract cli to load schema json and prepare jobs to process vector mbtiles. BM-1267 (#3429) (db113e2)
• cli: add cli-config package BM-1260 (#3428) (4ca5a47)
• cli: move cogify create-config into cli-config package BM-1261 (#3432) (5f72430)
• cli: rename cogify package to cli-raster BM-1262 (#3433) (36d4449)
• cli: update cli-package commands to cmd-ts BM-1259 (#3427) (46cc342)