@agilecustoms/envctl 1.16.1 → 1.18.0

package/README.md

@@ -7,7 +7,7 @@
 
 ```shell
 terraform init -backend-config=key=laxa1986
-envctl deploy -var-file=versions.tfvars -var="log_level=debug"
+envctl apply -var-file=versions.tfvars -var="log_level=debug"
 envctl delete
 ```
 
@@ -43,9 +43,10 @@ Creation API yields unique ID, so you can safely extend lifetime via this ID
 
 ### Authorization
 
-There are two main use cases:
-1. create an environment from CI (mainly ephemeral envs)
-2. create env from a dev machine
+Main use cases:
+1. create env from a dev machine
+2. env created automatically per feature branch
+3. create an ephemeral environment on CI
 
 Originally I (Alex C) have chosen IAM authorization (`/ci/deployer` on pipeline via OIDC, `/developer` on dev machine via SSO)
 Then (Feb 2026) I reworked it to use API keys

package/dist/client/Cli.js

@@ -110,7 +110,7 @@ export class Cli {
             });
         });
     }
-    getKind() {
+    getDir() {
         return path.basename(process.cwd());
     }
     async writeInTmpFile(stream, fileName) {

package/dist/commands/_keys.js

@@ -1,6 +1,5 @@
 export const _keys = {
     FORCE: 'Force deletion without confirmation',
     KEY: 'Environment name/identifier - taken from remote stake key, must be unique for a given customer',
-    KIND: 'Environment kind',
     PROFILE: 'Profile to use'
 };

package/dist/commands/{deploy.js → apply.js}

@@ -2,9 +2,9 @@ import { Command } from 'commander';
 import { ConfigService, EnvService } from '../service/index.js';
 import { _keys } from './_keys.js';
 import { wrap } from './_utils.js';
-export function deploy(program, configService, envService) {
+export function apply(program, configService, envService) {
     program
-        .command('deploy')
+        .command('apply')
         .description('Create new or update existing environment')
         .option('--profile <profile>', _keys.PROFILE)
         .allowUnknownOption(true)
@@ -12,6 +12,6 @@ export function deploy(program, configService, envService) {
         .action(wrap(async (tfArgs, options) => {
         const { profile } = options;
         configService.init(profile);
-        await envService.deploy(tfArgs);
+        await envService.apply(tfArgs);
     }));
 }

package/dist/commands/index.js

@@ -1,7 +1,7 @@
+export { apply } from './apply.js';
 export { configure } from './configure.js';
 export { createEphemeral } from './createEphemeral.js';
 export { deleteIt } from './delete.js';
-export { deploy } from './deploy.js';
 export { destroy } from './destroy.js';
 export { logs } from './logs.js';
 export { plan } from './plan.js';

package/dist/commands/plan.js

@@ -5,7 +5,7 @@ import { wrap } from './_utils.js';
 export function plan(program, configService, envService) {
     program
         .command('plan')
-        .description('High level wrapper for terraform plan. Compliments deploy command: if you plan to deploy env with envctl deploy,'
+        .description('High level wrapper for terraform plan. Compliments apply command: if you plan to deploy env with envctl apply,'
         + ' then it is recommended to do plan with envctl plan to guarantee consistent behavior')
         .option('--profile <profile>', _keys.PROFILE)
         .allowUnknownOption(true)

package/dist/index.js

@@ -2,7 +2,7 @@
 import { createRequire } from 'module';
 import { Command } from 'commander';
 import updateNotifier from 'update-notifier';
-import { configure, createEphemeral, deleteIt, deploy, destroy, logs, plan, status } from './commands/index.js';
+import { configure, createEphemeral, deleteIt, apply, destroy, logs, plan, status } from './commands/index.js';
 import { buildContainer } from './container.js';
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');
@@ -18,10 +18,10 @@ program
     .version(pkg.version, '', 'Output the version number')
     .helpOption('-h, --help', 'Display help for command')
     .option('--verbose', 'Verbose output (w/ debug logs)');
+apply(program, configService, envService);
 configure(program, configService);
 createEphemeral(program, configService, envService);
 deleteIt(program, configService, envService);
-deploy(program, configService, envService);
 destroy(program, configService, envService);
 logs(program, configService, logService);
 plan(program, configService, envService);

package/dist/service/EnvService.js

@@ -27,10 +27,10 @@ export class EnvService extends BaseService {
         if (env.status !== EnvStatus.Deleting && env.status !== EnvStatus.DeleteError) {
             logger.info(`Expires at ${toLocalTime(env.ttl)}`);
         }
-        if (env.kind) {
-            const kind = this.cli.getKind();
-            if (env.kind !== kind) {
-                logger.warn(`Env ${key} kind (dir-name): ${env.kind} - looks like this env was deployed from a different directory`);
+        if (env.dir) {
+            const dir = this.cli.getDir();
+            if (env.dir !== dir) {
+                logger.warn(`Env ${key} was deployed from ${env.dir}`);
             }
         }
     }
@@ -45,13 +45,13 @@ export class EnvService extends BaseService {
         }
         return env;
     }
-    checkKind(env) {
+    checkDir(env) {
         if (env.ephemeral)
             return;
-        if (env.kind) {
-            const kind = this.cli.getKind();
-            if (kind !== env.kind) {
-                throw new KnownException(`Env ${env.key} kind (dir-name): ${env.kind} - make sure you run this command from the same directory`);
+        if (env.dir) {
+            const dir = this.cli.getDir();
+            if (dir !== env.dir) {
+                throw new KnownException(`Env ${env.key} was deployed from ${env.dir} - make sure you run this command from the same directory`);
             }
         }
     }
@@ -59,7 +59,7 @@ export class EnvService extends BaseService {
         const key = this.terraformAdapter.getTerraformBackend().getKey();
         const env = await this.tryGetEnv(key);
         if (env) {
-            this.checkKind(env);
+            this.checkDir(env);
             this.handleDeleteStatuses(env);
         }
         const newEnv = env === null;
@@ -112,21 +112,20 @@ export class EnvService extends BaseService {
        Check logs with 'envctl logs', address the issue and re-run 'envctl delete ${env.key}'`);
         }
     }
-    async deploy(tfArgs) {
+    async apply(tfArgs) {
         const key = this.terraformAdapter.getTerraformBackend().getKey();
         let env = await this.tryGetEnv(key);
         if (env === null) {
-            const kind = this.cli.getKind();
-            logger.info(`Inferred kind from directory name: ${kind}`);
-            const createEnv = { key, kind };
+            const dir = this.cli.getDir();
+            const createEnv = { key, dir };
             await this.lockTerraform(createEnv, true);
             tfArgs = await this.ensurePlan({ key, ephemeral: false }, tfArgs);
             logger.info('Creating env metadata');
             env = await this.envApi.create(createEnv);
-            await this.runDeploy(env, tfArgs);
+            await this.runApply(env, tfArgs);
             return;
         }
-        this.checkKind(env);
+        this.checkDir(env);
         this.handleDeleteStatuses(env);
         const status = env.status;
         if (status === EnvStatus.Deploying || status === EnvStatus.Updating) {
@@ -146,13 +145,13 @@ export class EnvService extends BaseService {
                 logger.info('Will lock for update and run terraform apply (to update resources)');
             }
             await this.envApi.lockForUpdate(env);
-            await this.runDeploy(env, tfArgs);
+            await this.runApply(env, tfArgs);
             return;
         }
         tfArgs = await this.ensurePlan(env, tfArgs);
-        await this.runDeploy(env, tfArgs);
+        await this.runApply(env, tfArgs);
     }
-    async runDeploy(env, tfArgs) {
+    async runApply(env, tfArgs) {
         logger.info('Deploying resources');
         await this.terraformAdapter.apply(tfArgs, env.ttl);
         logger.info('Activating env (to finish creation)');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilecustoms/envctl",
-  "version": "1.16.1",
+  "version": "1.18.0",
   "description": "node.js CLI client for manage environments",
   "keywords": [
     "terraform wrapper",
@@ -44,8 +44,8 @@
     "run-core-init": "  cd ../tt-core && terraform init -upgrade -backend-config=key=laxa1986 -reconfigure",
     "run-core-status": " CWD=../tt-core npm run it -- status --verbose",
     "run-core-plan": "   CWD=../tt-core npm run it -- plan -out=.terraform/plan",
-    "run-core-deployp": "CWD=../tt-core npm run it -- deploy .terraform/plan",
-    "run-core-deploy": " CWD=../tt-core npm run it -- deploy",
+    "run-core-applyp": " CWD=../tt-core npm run it -- apply .terraform/plan",
+    "run-core-apply": "  CWD=../tt-core npm run it -- apply",
     "run-core-delete": " CWD=../tt-core npm run it -- delete",
     "run-core-destroy": "CWD=../tt-core npm run it -- destroy",
     "run-core-logs": "   CWD=../tt-core npm run it -- logs",
@@ -53,14 +53,14 @@
     "run-init": "cd ../tt-gitops && terraform init -upgrade -backend-config=key=laxa1986 -reconfigure",
     "run-status": "                                 CWD=../tt-gitops npm run it -- status",
     "run-plan": "   AWS_PROFILE=ac-tt-dev-deployer  CWD=../tt-gitops npm run it -- plan -var-file=versions.tfvars",
-    "run-deploy": " AWS_PROFILE=ac-tt-dev-deployer  CWD=../tt-gitops npm run it -- deploy -var-file=versions.tfvars",
+    "run-apply": " AWS_PROFILE=ac-tt-dev-deployer   CWD=../tt-gitops npm run it -- apply -var-file=versions.tfvars",
     "run-delete": "                                 CWD=../tt-gitops npm run it -- delete",
     "run-destroy": "AWS_PROFILE=ac-tt-dev-destroyer CWD=../tt-gitops npm run it -- destroy -var-file=versions.tfvars",
     "-": "",
     "run-ephemeral-create": " npm run it -- create-ephemeral test",
     "run-ephemeral-init": "cd ../tt-gitops && terraform init -upgrade -backend-config=key=test -reconfigure",
     "run-ephemeral-status": " CWD=../tt-gitops npm run it -- status test",
-    "run-ephemeral-deploy": " CWD=../tt-gitops npm run it -- deploy -var-file=versions.tfvars",
+    "run-ephemeral-apply": "  CWD=../tt-gitops npm run it -- apply -var-file=versions.tfvars",
     "run-ephemeral-delete": " CWD=../tt-gitops npm run it -- delete --force",
     "run-ephemeral-destroy": "CWD=../tt-gitops npm run it -- destroy --force -var-file=versions.tfvars"
   },