@aetherionfw/cli 1.0.0 → 1.1.1

package/README.md

@@ -0,0 +1,42 @@
+# @aetherionfw/cli
+
+> Command Line Interface for the Aetherion Serverless Framework.
+
+Aetherion is a modern, TypeScript-first serverless framework designed to bring the developer experience of frameworks like NestJS to AWS serverless architectures.
+
+## Overview
+
+This package provides the `aetherion` command to initialize, synthesize, deploy, and manage your applications.
+
+## Installation
+
+```bash
+npm install -g @aetherionfw/cli
+```
+
+*Note: The CLI is typically installed locally in your project as a dev dependency.*
+
+## Commands
+
+### `aetherion init <project-name>`
+Scaffolds a new Aetherion project with the recommended directory structure, TypeScript configuration, and boilerplate code.
+
+### `aetherion check-env`
+Verifies your AWS credentials and connection using the STS `GetCallerIdentity` action. It reads your `aetherion.config.ts` and ensures you are deploying to the correct AWS account.
+
+### `aetherion synth`
+Synthesizes your infrastructure decorators into Terraform JSON (runs `cdktf synth` under the hood).
+
+### `aetherion deploy`
+Deploys your infrastructure to AWS (runs `cdktf deploy --auto-approve` under the hood).
+
+### `aetherion docs`
+Generates an OpenAPI specification from your `@Route` decorators and serves a local documentation UI using Scalar.
+
+## Documentation
+
+For full documentation, visit [https://github.com/CrisD3v/Aetherion-framework](https://github.com/CrisD3v/Aetherion-framework).
+
+## License
+
+MIT

package/dist/bin/aetherion.js

@@ -10,6 +10,7 @@ const init_1 = require("../commands/init");
 const synth_1 = require("../commands/synth");
 const deploy_1 = require("../commands/deploy");
 const docs_1 = require("../commands/docs");
+const check_env_1 = require("../commands/check-env");
 const program = new commander_1.Command();
 program
     .name('aetherion')
@@ -32,6 +33,10 @@ program
     .description('Generate OpenAPI documentation')
     .option('-s, --serve', 'Serve the documentation using Scalar UI locally')
     .action(docs_1.docsCommand);
+program
+    .command('check-env')
+    .description('Verify AWS credentials and connection using STS GetCallerIdentity')
+    .action(check_env_1.checkEnvCommand);
 program.parse(process.argv);
 if (!process.argv.slice(2).length) {
     program.outputHelp();

package/dist/commands/check-env.d.ts

@@ -0,0 +1 @@
+export declare function checkEnvCommand(): Promise<void>;

package/dist/commands/check-env.js

@@ -0,0 +1,120 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkEnvCommand = checkEnvCommand;
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const client_sts_1 = require("@aws-sdk/client-sts");
+const credential_providers_1 = require("@aws-sdk/credential-providers");
+/**
+ * Loads aetherion.config.ts/js from the current working directory.
+ * Returns null if not found (will fall back to env vars / default profile).
+ */
+function loadConfig() {
+    const candidates = [
+        path.resolve(process.cwd(), 'aetherion.config.ts'),
+        path.resolve(process.cwd(), 'aetherion.config.js'),
+    ];
+    for (const candidate of candidates) {
+        if (fs.existsSync(candidate)) {
+            try {
+                // eslint-disable-next-line @typescript-eslint/no-require-imports
+                const mod = require(candidate);
+                return mod.default ?? mod;
+            }
+            catch {
+                // Ignore require errors — will be reported separately
+            }
+        }
+    }
+    return null;
+}
+async function checkEnvCommand() {
+    const spinner = (0, ora_1.default)('Reading Aetherion config...').start();
+    const fileConfig = loadConfig();
+    // Env vars always override the config file (CI/CD friendly)
+    const region = process.env.AWS_REGION ??
+        process.env.AWS_DEFAULT_REGION ??
+        fileConfig?.region ??
+        'us-east-1';
+    const profile = process.env.AWS_PROFILE ?? fileConfig?.profile;
+    const expectedAccountId = process.env.AWS_ACCOUNT_ID ?? fileConfig?.accountId;
+    spinner.text = 'Connecting to AWS STS...';
+    try {
+        const clientConfig = { region };
+        // Use named profile credentials when a profile is configured
+        if (profile) {
+            clientConfig.credentials = (0, credential_providers_1.fromIni)({ profile });
+        }
+        const client = new client_sts_1.STSClient(clientConfig);
+        const response = await client.send(new client_sts_1.GetCallerIdentityCommand({}));
+        spinner.succeed(chalk_1.default.green('AWS connection verified successfully!\n'));
+        console.log(chalk_1.default.bold('  Identity:'));
+        console.log(`    ${chalk_1.default.dim('Account :')} ${chalk_1.default.cyan(response.Account)}`);
+        console.log(`    ${chalk_1.default.dim('UserId  :')} ${chalk_1.default.cyan(response.UserId)}`);
+        console.log(`    ${chalk_1.default.dim('ARN     :')} ${chalk_1.default.cyan(response.Arn)}`);
+        console.log(`    ${chalk_1.default.dim('Region  :')} ${chalk_1.default.cyan(region)}`);
+        if (profile) {
+            console.log(`    ${chalk_1.default.dim('Profile :')} ${chalk_1.default.cyan(profile)}`);
+        }
+        // Warn if the resolved account differs from what is configured
+        if (expectedAccountId && response.Account !== expectedAccountId) {
+            console.log();
+            console.log(chalk_1.default.yellow(`  ⚠ Warning: The active AWS account (${response.Account}) does not match` +
+                ` the accountId in your config (${expectedAccountId}).`));
+        }
+        else if (expectedAccountId) {
+            console.log();
+            console.log(chalk_1.default.green(`  ✔ Account matches aetherion.config.ts (${response.Account})`));
+        }
+        console.log();
+    }
+    catch (err) {
+        spinner.fail(chalk_1.default.red('AWS connection failed.'));
+        console.error();
+        console.error(chalk_1.default.red(`  Error: ${err.message}`));
+        console.error();
+        console.error(chalk_1.default.dim('  Troubleshooting:'));
+        console.error(chalk_1.default.dim('    • Make sure your AWS credentials are configured (~/.aws/credentials or environment variables).'));
+        console.error(chalk_1.default.dim('    • If using a named profile, ensure it is set in aetherion.config.ts under the `profile` field.'));
+        console.error(chalk_1.default.dim('    • Verify that the profile has permission to call sts:GetCallerIdentity.'));
+        process.exit(1);
+    }
+}

package/dist/commands/docs.js

@@ -44,6 +44,7 @@ const ora_1 = __importDefault(require("ora"));
 const docs_1 = require("@aetherionfw/docs");
 const path = __importStar(require("path"));
 const fs = __importStar(require("fs"));
+const open_1 = __importDefault(require("open"));
 async function docsCommand(options) {
     const isServe = options.serve;
     const spinner = (0, ora_1.default)('Preparing OpenAPI documentation...').start();
@@ -61,13 +62,17 @@ async function docsCommand(options) {
         else {
             spinner.warn(chalk_1.default.yellow('src/app.module.ts not found. API documentation might be empty.'));
         }
+        // Always generate the static docs
+        (0, docs_1.generateStaticDocs)(process.cwd());
         if (isServe) {
             spinner.succeed(chalk_1.default.green('Starting Scalar API Reference Server...'));
             (0, docs_1.startScalarServer)(3000);
+            const url = 'http://localhost:3000/docs';
+            console.log(chalk_1.default.cyan(`\nOpening browser at ${url}`));
+            await (0, open_1.default)(url);
             // Keep process alive
         }
         else {
-            (0, docs_1.generateStaticDocs)(process.cwd());
             spinner.succeed(chalk_1.default.green('Documentation generated at openapi.json'));
         }
     }

package/package.json

@@ -1,25 +1,28 @@
 {
   "name": "@aetherionfw/cli",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "CLI for Aetherion Framework",
   "bin": {
     "aetherion": "dist/bin/aetherion.js"
   },
   "dependencies": {
+    "@aws-sdk/client-sts": "^3.0.0",
+    "@aws-sdk/credential-providers": "^3.0.0",
     "chalk": "^4.1.2",
     "commander": "^11.0.0",
     "fs-extra": "^11.1.1",
+    "open": "^8.4.2",
     "ora": "^5.4.1",
     "ts-node": "^10.9.2",
-    "@aetherionfw/docs": "1.0.0"
+    "@aetherionfw/docs": "1.1.1"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.1",
     "@types/node": "^20.0.0",
     "typescript": "^5.5.4",
     "vitest": "^2.0.5",
-    "@aetherionfw/core": "1.0.0",
-    "@aetherionfw/infra": "1.0.0"
+    "@aetherionfw/core": "1.1.1",
+    "@aetherionfw/infra": "1.1.1"
   },
   "publishConfig": {
     "access": "public"
@@ -32,6 +35,11 @@
   ],
   "author": "CrisD3v",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CrisD3v/Aetherion-framework.git",
+    "directory": "packages/cli"
+  },
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf dist"

package/template/.env.example

@@ -0,0 +1,12 @@
+# Aetherion deployment environment variables
+# Copy this file to .env and fill in your values.
+# Never commit .env to version control.
+
+# Your AWS Account ID (12-digit number)
+AWS_ACCOUNT_ID=123456789012
+
+# Target AWS region
+AWS_REGION=us-east-1
+
+# Named AWS CLI profile from ~/.aws/credentials (leave empty in CI/CD)
+AWS_PROFILE=default

package/template/aetherion.config.ts

@@ -0,0 +1,33 @@
+import { defineConfig } from '@aetherionfw/core';
+import 'dotenv/config';
+
+/**
+ * Aetherion deployment configuration.
+ *
+ * Environment variables always override these values — useful for CI/CD pipelines.
+ * Sensitive values (account IDs, secrets) should be loaded from environment variables
+ * or a secrets manager rather than hardcoded here.
+ *
+ * Required env vars (can be set in a .env file):
+ *   AWS_ACCOUNT_ID  - Your AWS account ID
+ *   AWS_REGION      - Target region (e.g. us-east-1)
+ *   AWS_PROFILE     - Named profile from ~/.aws/credentials (optional for CI/CD)
+ */
+export default defineConfig({
+  /**
+   * AWS Account ID.
+   * Run `aws sts get-caller-identity` or `aetherion check-env` to find yours.
+   */
+  accountId: process.env.AWS_ACCOUNT_ID!,
+
+  /**
+   * AWS region where all resources will be deployed.
+   */
+  region: process.env.AWS_REGION ?? 'us-east-1',
+
+  /**
+   * Named AWS CLI profile for local development.
+   * Remove or leave undefined when deploying from CI/CD using IAM roles or env vars.
+   */
+  profile: process.env.AWS_PROFILE ?? 'default',
+});