@ibm-cloud/cd-tools 1.0.0

package/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to publish GitHub releases
+      issues: write # to comment on released issues
+      pull-requests: write # to comment on released pull requests
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,2 @@
+# continuous-delivery-tools
+Tools and utilities for the IBM Cloud Continuous Delivery service and resources

package/cmd/check-secrets.js

@@ -0,0 +1,106 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+'use strict';
+
+import { exit } from 'node:process';
+import { Command } from 'commander';
+import { parseEnvVar, decomposeCrn, isSecretReference } from './utils/utils.js';
+import { logger, LOG_STAGES } from './utils/logger.js';
+import { getBearerToken, getToolchainTools, getPipelineData } from './utils/requests.js';
+import { UPDATEABLE_SECRET_PROPERTIES_BY_TOOL_TYPE } from '../config.js';
+
+const command = new Command('check-secrets')
+  .description('Checks if you have any stored secrets in your toolchain or pipelines')
+  .requiredOption('-c, --toolchain-crn <crn>', 'The CRN of the source toolchain to check')
+  .option('-a --apikey <api key>', 'IBM Cloud IAM API key with permissions to read the toolchain.')
+  .showHelpAfterError()
+  .hook('preAction', cmd => cmd.showHelpAfterError(false)) // only show help during validation
+  .action(main);
+
+async function main(options) {
+    const toolchainCrn = options.toolchainCrn;
+    const apiKey = options.apikey || parseEnvVar('IBMCLOUD_API_KEY');
+
+    if (!apiKey) {
+        logger.error('Missing IBM Cloud IAM API key', LOG_STAGES.setup);
+        exit(1);
+    };
+
+    logger.print(`Checking secrets for toolchain ${toolchainCrn}...`);
+
+    const decomposedCrn = decomposeCrn(toolchainCrn);
+
+    const token = await getBearerToken(apiKey);
+    const toolchainId = decomposedCrn.serviceInstance;
+    const region = decomposedCrn.location;
+
+    const getToolsRes = await getToolchainTools(token, toolchainId, region);
+
+    const toolResults = [];
+    const pipelineResults = [];
+
+    if (getToolsRes?.tools?.length > 0) {
+        for (let i = 0; i < getToolsRes.tools.length; i++) {
+            const tool = getToolsRes.tools[i];
+
+            // Check tool integrations for any plain text secret values
+            if (UPDATEABLE_SECRET_PROPERTIES_BY_TOOL_TYPE[tool.tool_type_id]) {
+                UPDATEABLE_SECRET_PROPERTIES_BY_TOOL_TYPE[tool.tool_type_id].forEach((updateableSecretParam) => {
+                    if (tool.parameters[updateableSecretParam] && !isSecretReference(tool.parameters[updateableSecretParam])) {
+                        toolResults.push({
+                            'Tool ID': tool.id,
+                            'Tool Type': tool.tool_type_id,
+                            'Property Name': updateableSecretParam
+                        });
+                    };
+                });
+            };
+
+            // For tekton pipelines, check for any plain text secret properties
+            if (tool.tool_type_id === 'pipeline' && tool.parameters?.type === 'tekton') {
+                const pipelineData = await getPipelineData (token, tool.id, region);
+
+                pipelineData?.properties.forEach((prop) => {
+                    if (prop.type === 'secure' && !isSecretReference(prop.value)) {
+                        pipelineResults.push({
+                            'Pipeline ID': pipelineData.id,
+                            'Trigger Name': '-', 
+                            'Property Name': prop.name
+                        });
+                    };
+                });
+
+                pipelineData?.triggers.forEach((trigger) => {
+                    trigger.properties?.forEach((prop) => {
+                        if (prop.type === 'secure' && !isSecretReference(prop.value)) {
+                            pipelineResults.push({
+                                'Pipeline ID': pipelineData.id,
+                                'Trigger Name': trigger.name, 
+                                'Property Name': prop.name
+                            });
+                        };
+                    });
+                });
+            }
+        };
+    };
+
+    if (toolResults.length > 0) {
+        logger.print();
+        logger.print('The following plain text properties were found in tool integrations bound to the toolchain:');
+        logger.table(toolResults);
+    };
+    if (pipelineResults.length > 0) {
+        logger.print();
+        logger.print('The following plain text properties were found in Tekton pipeline(s) bound to the toolchain:');
+        logger.table(pipelineResults);
+    };
+};
+
+export default command;

package/cmd/copy-toolchain.js

@@ -0,0 +1,333 @@
+/**
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2025. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ */
+
+import { exit } from 'node:process';
+import { resolve } from 'node:path'
+import fs from 'node:fs';
+
+import { Command, Option } from 'commander';
+
+import { parseEnvVar } from './utils/utils.js';
+import { logger, LOG_STAGES } from './utils/logger.js';
+import { setTerraformerEnv, setTerraformEnv, initProviderFile, runTerraformerImport, setupTerraformFiles, runTerraformInit, getNumResourcesPlanned, runTerraformApply, getNumResourcesCreated, getNewToolchainId } from './utils/terraform.js';
+import { getAccountId, getBearerToken, getResourceGroupId, getToolchain } from './utils/requests.js';
+import { validatePrereqsVersions, validateResourceGroupId, validateTag, validateToolchainId, validateToolchainName, validateTools, validateOAuth, warnDuplicateName, validateGritUrl } from './utils/validate.js';
+
+import { COPY_TOOLCHAIN_DESC, MIGRATION_DOC_URL, TARGET_REGIONS, SOURCE_REGIONS } from '../config.js';
+
+process.on('exit', (code) => {
+	if (code !== 0) logger.print(`Need help? Visit ${MIGRATION_DOC_URL} for more troubleshooting information.`);
+});
+
+const LOGS_DIR = '.logs';
+const TEMP_DIR = '.migration-temp'
+const DEBUG_MODE = false; // when true, temp folder is preserved
+const OUTPUT_DIR = 'output-' + new Date().getTime();
+const DRY_RUN = false; // when true, terraform apply does not run
+
+
+const command = new Command('copy-toolchain')
+	.summary('Copies a toolchain, including tool integrations and Tekton pipelines, to another region or resource group.')
+	.description(COPY_TOOLCHAIN_DESC)
+	.optionsGroup('Basic options:')
+	.requiredOption('-c, --toolchain-crn <crn>', 'The CRN of the source toolchain to copy')
+	.addOption(
+		new Option('-r, --region <region>', 'The destination region of the copied toolchain')
+			.choices(TARGET_REGIONS)
+			.makeOptionMandatory()
+	)
+	.option('-a --apikey <api key>', 'API Key used to perform the copy. Must have IAM permission to read and create toolchains and S2S authorizations in source and target region / resource group')
+	.option('-n, --name <name>', '(Optional) The name of the copied toolchain (default: same name as original)')
+	.option('-g, --resource-group <resource group>', '(Optional) The name or ID of destination resource group of the copied toolchain (default: same resource group as original)')
+	.option('-t, --tag <tag>', '(Optional) The tag to add to the copied toolchain')
+	.helpOption('-h, --help', 'Display help for command')
+	.optionsGroup('Advanced options:')
+	.option('-d, --terraform-dir <directory path>', '(Optional) The target local directory to store the generated Terraform (.tf) files')
+	.option('-D, --dry-run', '(Optional) Skip running terraform apply')
+	.option('-f, --force', '(Optional) Force the copy toolchain command to run without user confirmation')
+	.option('-S, --skip-s2s', '(Optional) Skip importing toolchain-generated S2S authorizations')
+	.option('-T, --skip-disable-triggers', '(Optional) Skip disabling triggers')
+	.option('-C, --compact', '(Optional) Generate all resources in resources.tf')
+	.option('-v --verbose', '(Optional) Increase log output')
+	.option('-s --silent', '(Optional) Suppress non-essential output, only errors and critical warnings are displayed')
+	.option('-G --grit-mapping-file <path>', '(Optional) JSON file mapping GRIT project urls to project urls in the target region')
+	.showHelpAfterError()
+	.hook('preAction', cmd => cmd.showHelpAfterError(false)) // only show help during validation
+	.action(main);
+
+async function main(options) {
+	const sourceToolchainCrn = options.toolchainCrn;
+	const targetRegion = options.region;
+	const targetRg = options.resourceGroup;
+	const outputDir = resolve(options.terraformDir || OUTPUT_DIR);
+	const dryRun = options.dryRun || DRY_RUN;
+	const skipUserConfirmation = options.force || false;
+	const includeS2S = !options.skipS2s;
+	const disableTriggers = !options.skipDisableTriggers;
+	const isCompact = options.compact || false;
+	const verbosity = options.silent ? 0 : options.verbose ? 2 : 1;
+
+	logger.setVerbosity(verbosity);
+	logger.createLogStream(`${LOGS_DIR}/copy-toolchain-${new Date().getTime()}.log`);
+	logger.dump(`Options: ${JSON.stringify(options)}\n`);
+
+	let bearer;
+	let sourceToolchainId;
+	let sourceRegion;
+	let sourceToolchainData;
+	let targetToolchainName = options.name;
+	let targetTag = options.tag;
+	let targetRgId;
+	let apiKey = options.apikey;
+	let moreTfResources = {};
+	let gritMapping = {};
+
+	// Validate arguments are valid and check if Terraformer and Terraform are installed appropriately
+	try {
+		validatePrereqsVersions();
+
+		if (!apiKey) apiKey = parseEnvVar('IBMCLOUD_API_KEY');
+		bearer = await getBearerToken(apiKey);
+		const accountId = await getAccountId(bearer, apiKey);
+
+		if (options.gritMappingFile) {
+			gritMapping = JSON.parse(fs.readFileSync(resolve(options.gritMappingFile)));
+			const gritPromises = [];
+			let errorCount = 0;
+
+			// check validity of mapped values
+			Object.entries(gritMapping)
+				.forEach(([k, v]) => {
+					gritPromises.push(validateGritUrl(bearer, targetRegion, v, true).catch((e) => {
+						if (errorCount < 5) {
+							logger.error(`Value of key '${k}' from GRIT mapping file is invalid`, LOG_STAGES.setup);
+							logger.error(e, LOG_STAGES.setup);
+						} else if (errorCount === 5) {
+							logger.error(`( ...additional GRIT mapping file error messages truncated )`, LOG_STAGES.setup);
+						}
+						errorCount += 1;
+					}));
+				});
+			await Promise.all(gritPromises);
+			if (errorCount > 0) throw Error(`One or more invalid entries in GRIT mapping file, error count: ${errorCount}`);
+		}
+
+		[sourceToolchainId, sourceRegion] = parseToolchainCrn(sourceToolchainCrn);
+
+		if (targetToolchainName) validateToolchainName(targetToolchainName);
+		if (targetTag) validateTag(targetTag);
+
+		sourceToolchainData = await logger.withSpinner(getToolchain,
+			'Validating toolchain...',
+			'Toolchain validated',
+			LOG_STAGES.setup,
+			bearer,
+			sourceToolchainId,
+			sourceRegion
+		);
+
+		if (sourceToolchainCrn != sourceToolchainData['crn']) {
+			logger.error('Provided toolchain CRN is invalid', LOG_STAGES.setup);
+			exit(1);
+		}
+
+		if (!targetRg) {
+			// reuse resource group if not provided
+			targetRgId = sourceToolchainData['resource_group_id'];
+		} else {
+			targetRgId = await getResourceGroupId(bearer, accountId, targetRg);
+			validateResourceGroupId(targetRgId);
+		}
+
+		// reuse name if not provided
+		if (!targetToolchainName) targetToolchainName = sourceToolchainData['name'];
+		[targetToolchainName, targetTag] = await warnDuplicateName(bearer, accountId, targetToolchainName, sourceRegion, targetRegion, targetRgId, targetTag, skipUserConfirmation);
+
+		const allTools = await logger.withSpinner(validateTools,
+			'Validating Toolchain Tool(s)...',
+			'Toolchain tool(s) validated',
+			LOG_STAGES.setup,
+			bearer,
+			sourceToolchainId,
+			sourceRegion,
+			skipUserConfirmation
+		);
+
+		// validate git tools OAuth
+		await logger.withSpinner(validateOAuth,
+			'Validating Git OAuth in target region...',
+			'OAuth validated',
+			LOG_STAGES.setup,
+			bearer,
+			allTools,
+			targetRegion,
+			skipUserConfirmation
+		)
+
+		// collect instances of legacy GHE tool integrations
+		const collectGHE = () => {
+			moreTfResources['github_integrated'] = [];
+			allTools.forEach((t) => {
+				if (t.tool_type_id === 'github_integrated') {
+					moreTfResources['github_integrated'].push(t);
+				}
+			});
+		};
+
+		collectGHE();
+
+		logger.info('Arguments and required packages verified, proceeding with copying toolchain...', LOG_STAGES.setup);
+
+		// Set up temp folder
+		if (!fs.existsSync(TEMP_DIR)) {
+			fs.mkdirSync(TEMP_DIR);
+		}
+	}
+	catch (err) {
+		if (err.message && err.stack) {
+			const errMsg = verbosity > 1 ? err.stack : err.message;
+			logger.error(errMsg, LOG_STAGES.setup);
+		}
+		await handleCleanup();
+		exit(1);
+	}
+
+	try {
+		const runTerraformer = async () => {
+			setTimeout(() => {
+				logger.updateSpinnerMsg('Still importing toolchain...');
+			}, 5000);
+
+			setTerraformerEnv(apiKey, sourceToolchainId, includeS2S);
+
+			await initProviderFile(sourceRegion, TEMP_DIR);
+			await runTerraformInit(TEMP_DIR);
+
+			await runTerraformerImport(sourceRegion, TEMP_DIR, isCompact, verbosity);
+		};
+		await logger.withSpinner(
+			runTerraformer,
+			'Importing toolchain...',
+			'Toolchain successfully imported using Terraformer',
+			LOG_STAGES.terraformer
+		);
+	} catch (err) {
+		if (err.message && err.stack) {
+			const errMsg = verbosity > 1 ? err.stack : err.message;
+			logger.error(errMsg, LOG_STAGES.terraformer);
+		}
+		await handleCleanup();
+		exit(1);
+	}
+
+	// Prepare for Terraform
+	try {
+		if (!fs.existsSync(outputDir)) {
+			logger.info(`Creating output directory "${outputDir}"...`, LOG_STAGES.terraformer);
+			fs.mkdirSync(outputDir);
+		} else {
+			logger.info(`Output directory "${outputDir}" already exists`, LOG_STAGES.terraformer);
+		}
+
+		await setupTerraformFiles({
+			token: bearer,
+			srcRegion: sourceRegion,
+			targetRegion: targetRegion,
+			targetTag: targetTag,
+			targetToolchainName: targetToolchainName,
+			targetRgId: targetRgId,
+			disableTriggers: disableTriggers,
+			isCompact: isCompact,
+			outputDir: outputDir,
+			tempDir: TEMP_DIR,
+			moreTfResources: moreTfResources,
+			gritMapping: gritMapping,
+			skipUserConfirmation: skipUserConfirmation
+		});
+	} catch (err) {
+		if (err.message && err.stack) {
+			const errMsg = verbosity > 1 ? err.stack : err.message;
+			logger.error(errMsg, LOG_STAGES.terraformer);
+		}
+		await handleCleanup();
+		exit(1);
+	}
+
+	// Run Terraform
+	try {
+		if (!dryRun) {
+			setTerraformEnv(verbosity);
+
+			await logger.withSpinner(runTerraformInit,
+				'Running terraform init...',
+				'Terraform successfully initialized',
+				LOG_STAGES.tf,
+				outputDir
+			);
+
+			logger.info(`DRY_RUN: ${dryRun}, running terraform apply...`, LOG_STAGES.tf);
+
+			// get total planned resources before applying
+			const numResourcesPlanned = await getNumResourcesPlanned(outputDir);
+
+			let applyErrors = false;
+
+			await runTerraformApply(skipUserConfirmation, outputDir, verbosity).catch((err) => {
+				logger.error(err, LOG_STAGES.tf);
+				applyErrors = true;
+			});
+
+			const newTcId = await getNewToolchainId(outputDir);
+			const numResourcesCreated = await getNumResourcesCreated(outputDir);
+
+			logger.print('\n');
+			logger.info(`Toolchain "${sourceToolchainData['name']}" from ${sourceRegion} was cloned to "${targetToolchainName ?? sourceToolchainData['name']}" in ${targetRegion} ${applyErrors ? 'with some errors' : 'successfully'}, with ${numResourcesCreated} / ${numResourcesPlanned} resources created!`, LOG_STAGES.info);
+			if (newTcId) logger.info(`See cloned toolchain: https://cloud.ibm.com/devops/toolchains/${newTcId}?env_id=ibm:yp:${targetRegion}`, LOG_STAGES.info, true);
+		} else {
+			logger.info(`DRY_RUN: ${dryRun}, skipping terraform apply...`, LOG_STAGES.tf);
+		}
+	} catch (err) {
+		if (err.message && err.stack) {
+			const errMsg = verbosity > 1 ? err.stack : err.message;
+			logger.error(errMsg, LOG_STAGES.tf);
+		}
+		await handleCleanup();
+		exit(1);
+	}
+
+	await handleCleanup();
+	exit(0);
+}
+
+async function handleCleanup() {
+	if (!DEBUG_MODE) {
+		if (fs.existsSync(TEMP_DIR)) fs.rmSync(TEMP_DIR, { recursive: true });
+	}
+	await logger.close();
+}
+
+// parses crn arg into toolchain ID and region
+function parseToolchainCrn(crn) {
+	// doesn't strictly check crn format
+	const pattern = /^crn:.*:.*:.*:toolchain:.*:.*:.*::$/;
+	if (typeof crn === 'string' && pattern.test(crn)) {
+		const crnParts = crn.toLowerCase().split(':');
+		if (crnParts.length === 10 && SOURCE_REGIONS.includes(crnParts[5])) {
+			try {
+				validateToolchainId(crnParts[7]);
+			} catch {
+				throw Error('Provided toolchain CRN is invalid');
+			}
+			return [crnParts[7], crnParts[5]];
+		}
+	}
+	throw Error('Provided toolchain CRN is invalid');
+}
+
+export default command;