Skip to main content

A simple construct that executes a command locally. This is useful to run build steps within your CDKTF Program or to run a post action after a resource is created.

Project description

CDKTF Local Exec Construct

A simple construct that executes a command locally. This is useful to run build steps within your CDKTF Program or to run a post action after a resource is created.

The construct uses the null provider to achieve this so it can be trusted to only run after all dependencies are met.

Usage

import { Provider, LocalExec } from "cdktf-local-exec";

// LocalExec extends from the null provider,
// so if you already have the provider initialized you can skip this step
new Provider(this, "local-exec");

const frontend = new LocalExec(this, "frontend-build", {
  // Will copy this into an asset directory
  cwd: "/path/to/project/frontend",
  command: "npm install && npm build",
});

const pathToUpload = `${frontend.path}/dist`;

new LocalExec(this, "frontend-upload", {
  cwd: pathToUpload,
  command: `aws s3 cp --recursive ${pathToUpload} s3://${bucket.name}/frontend`,
});

new LocalExec(this, "backend-build", {
  cwd: "/path/to/project/backend",
  copyBeforeRun: false, // can not run remotely since the runner has no docker access
  command: "docker build -t foo . && docker push foo",
});

Options

  • cwd: The working directory to run the command in. It will be copied before execution to ensure the asset can be used in a remote execution environment.
  • command: The command to execute.
  • copyBeforeRun: If true, the command will copy the cwd directory into a tmp dir and run there. If false, the command will be executed in the cwd directory.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdktf-local-exec-0.0.55.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

cdktf_local_exec-0.0.55-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

Details for the file cdktf-local-exec-0.0.55.tar.gz.

File metadata

  • Download URL: cdktf-local-exec-0.0.55.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for cdktf-local-exec-0.0.55.tar.gz
Algorithm Hash digest
SHA256 00682b6b9c25ce39fba83ad67b33747ac40e27e80ea6a3b51b53d919a67bbe2d
MD5 02632970662a19f80f23c5947f0832f3
BLAKE2b-256 891b02dcd743209d730a6699863ba411454b0bc4ce622c06f436b90576cd9f80

See more details on using hashes here.

File details

Details for the file cdktf_local_exec-0.0.55-py3-none-any.whl.

File metadata

  • Download URL: cdktf_local_exec-0.0.55-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for cdktf_local_exec-0.0.55-py3-none-any.whl
Algorithm Hash digest
SHA256 42485814a6e97808f3931b6e241380b8426a054e7b220a1784da73f73ce41c86
MD5 8a8b7e65199d4996689dd73da521f667
BLAKE2b-256 8f20f7ecffc6b196a0b784a14e95abc9e93c0dfb70d7c6a30794286aa299ce90

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page