@salza80/openclaw-aws 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sally Mclean
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,414 @@
+# openclaw-aws
+
+[![CI](https://github.com/salza80/openclaw-aws/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/salza80/openclaw-aws/actions/workflows/ci.yml)
+
+OpenClaw AWS is a CLI that makes it simple to provision and manage OpenClaw bots on AWS. It creates a minimal Ubuntu EC2 setup with secure SSM-only access.
+
+## Install
+
+```bash
+# Recommended: local install in your bot folder
+mkdir my-openclaw-bot
+cd my-openclaw-bot
+npm init -y
+npm install @salza80/openclaw-aws
+npx openclaw-aws --help
+
+# Alternative: run directly with npx (no install)
+npx @salza80/openclaw-aws --help
+
+# Alternative: install globally
+npm install -g @salza80/openclaw-aws
+openclaw-aws --help
+```
+
+## Quick Start
+
+```bash
+# Initialize your bot with interactive prompts
+# This will generate a config file
+npx openclaw-aws init
+
+# Deploy. -- That's it!
+npx openclaw-aws deploy
+
+# Wait for deploy to finish. View the status of your bot
+npx openclaw-aws status
+```
+
+If you installed locally, prefix commands with `npx openclaw-aws`.
+
+To access your bot:
+
+```bash
+# Open the dashboard to view in your browser (port forwarded via secure SSM - not public access)
+openclaw-aws dashboard
+# Opens http://localhost:18789 in your browser - short delay before it works - refresh browser after 5 seconds
+
+# Or connect to the instance via SSM - for full terminal access
+openclaw-aws connect
+```
+
+See the OpenClaw docs for ongoing configuration and usage guidance for your bot: [OpenClaw Documentation](https://docs.openclaw.ai/)
+
+Managing multiple bots / instances:
+
+```bash
+# This will generate another config file
+openclaw-aws init
+# deploy it
+openclaw-aws deploy
+
+# List all bot configs
+openclaw-aws list
+
+# View status of the currently selected config
+openclaw-aws status
+# View status of all configs
+openclaw-aws status --all
+
+# See the currently selected config.
+# Commands default to this config.
+openclaw-aws current
+
+# Select another config
+openclaw-aws use <name>
+
+# Run any command against a specific config or all configs with --name <name> or --all
+
+# get help with commands
+openclaw-aws --help
+```
+
+## Prerequisites
+
+- **Node.js 20+**
+- **AWS CLI v2 installed and authenticated** (SSO recommended)
+  - Install AWS CLI v2: [AWS CLI install guide](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
+  - Configure SSO: [AWS CLI SSO setup guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html)
+
+## Commands
+
+### `openclaw-aws init`
+
+Interactive setup wizard to create a config.
+
+**Example:**
+
+```bash
+openclaw-aws init
+```
+
+### `openclaw-aws deploy`
+
+Deploy infrastructure to AWS.
+
+**Example:**
+
+```bash
+openclaw-aws deploy
+openclaw-aws deploy --name my-bot
+openclaw-aws deploy --all
+```
+
+### `openclaw-aws status`
+
+Check deployment and instance status.
+
+**Example:**
+
+```bash
+openclaw-aws status
+openclaw-aws status --all
+```
+
+### `openclaw-aws dashboard`
+
+Forward port 18789 to access the OpenClaw dashboard locally.
+
+**Example:**
+
+```bash
+openclaw-aws dashboard
+```
+
+### `openclaw-aws connect`
+
+Connect to your EC2 instance via SSM.
+
+**Example:**
+
+```bash
+openclaw-aws connect
+```
+
+### `openclaw-aws start`
+
+Start a stopped instance.
+
+**Example:**
+
+```bash
+openclaw-aws start
+```
+
+### `openclaw-aws stop`
+
+Stop a running instance to save costs.
+
+**Example:**
+
+```bash
+openclaw-aws stop
+```
+
+### `openclaw-aws restart`
+
+Reboot the instance.
+
+**Example:**
+
+```bash
+openclaw-aws restart
+```
+
+### `openclaw-aws outputs`
+
+Show CloudFormation stack outputs.
+
+**Example:**
+
+```bash
+openclaw-aws outputs --name my-bot
+```
+
+### `openclaw-aws destroy`
+
+Delete all AWS resources.
+
+**Options:**
+
+- `--name <name>` - Config name
+- `--all` - Destroy all configs
+- `--force` - Skip confirmation
+- `--delete-config` - Delete configuration file
+
+**Example:**
+
+```bash
+openclaw-aws destroy --name my-bot
+openclaw-aws destroy --all
+
+# Force delete without confirmation
+openclaw-aws destroy --name my-bot --force
+```
+
+### `openclaw-aws list`
+
+List configs.
+
+**Example:**
+
+```bash
+openclaw-aws list
+```
+
+### `openclaw-aws current`
+
+Show the current config.
+
+**Example:**
+
+```bash
+openclaw-aws current
+```
+
+### `openclaw-aws use`
+
+Select a config.
+
+**Example:**
+
+```bash
+openclaw-aws use my-bot
+```
+
+## Configuration
+
+Configuration is created with the `init` command, and stored per config in `.openclaw-aws/configs/<name>.json`.
+The current selection is stored in `.openclaw-aws/current.json`.
+
+**Example configuration:**
+
+```json
+{
+  "version": "1.0",
+  "aws": {
+    "region": "us-east-1",
+    "profile": "default"
+  },
+  "instance": {
+    "type": "t3.micro",
+    "name": "openclaw-my-bot"
+  },
+  "network": {
+    "useDefaultVpc": true
+  },
+  "features": {
+    "cloudWatchLogs": true
+  },
+  "openclaw": {
+    "apiProvider": "anthropic-api-key"
+  },
+  "stack": {
+    "name": "OpenclawStack-my-bot"
+  }
+}
+```
+
+## Multiple Bots (Configs)
+
+To manage multiple bots, create one config per bot and switch between them:
+
+```bash
+openclaw-aws init --name bot-a
+openclaw-aws init --name bot-b
+openclaw-aws list
+openclaw-aws use bot-b
+openclaw-aws current
+```
+
+## Start/Stop (Cost Control)
+
+Use `stop` to save costs when you don’t need the bot running, and `start` to resume.
+
+```bash
+openclaw-aws stop --name my-bot
+openclaw-aws start --name my-bot
+```
+
+## Benefits & Setup
+
+- **Ubuntu 24.04 LTS** on EC2
+- **SSM-only access** (no SSH, no inbound ports)
+- **Encrypted EBS** by default
+- **IMDSv2 enforced** for metadata security
+
+## Architecture
+
+The deployment creates:
+
+- **EC2 Instance** - Ubuntu 24.04 LTS, t3.micro (or your chosen type)
+  - IMDSv2 enforced (SSRF protection)
+  - Encrypted EBS volume (data at rest encryption)
+  - Public IP assigned (required for outbound connectivity)
+- **Security Group** - Zero inbound rules (SSM access only, no SSH)
+- **IAM Role** - Least-privilege with SSM access
+- **VPC** - Uses default VPC by default (option to create new VPC)
+
+## Security
+
+- **No inbound ports** (SSM access only)
+- **No SSH** (disabled by design)
+- **Encrypted storage** with EBS
+- **SSM sessions** are auditable in CloudTrail
+
+### Troubleshooting - Instance not appearing in SSM
+
+Wait 2-3 minutes after deployment. Check status:
+
+```bash
+openclaw-aws status
+```
+
+### "Config file not found"
+
+Run the init command first:
+
+```bash
+openclaw-aws init
+openclaw-aws list
+openclaw-aws use my-bot
+```
+
+### Deployment fails
+
+Check AWS credentials:
+
+```bash
+aws sts get-caller-identity
+```
+
+### Port forwarding fails
+
+Ensure SSM plugin is installed and instance is ready:
+
+```bash
+openclaw-aws status
+```
+
+Restart instance if the gateway or SSM has crashed:
+
+```bash
+openclaw-aws restart
+```
+
+## Development
+
+For developers contributing to openclaw-aws:
+
+### Setup
+
+```bash
+# 1. Clone the repository
+git clone https://github.com/salza80/openclaw-aws.git
+cd openclaw-aws
+
+# 2. Use Node 20+
+nvm use
+
+# 3. Install dependencies
+npm install
+
+# 4. Build the project
+npm run build
+
+# 5. Link for local testing
+npm link
+
+# 6. Test the CLI
+openclaw-aws --help
+openclaw-aws init
+
+# 7. Watch mode for development (auto-rebuild on changes)
+npm run watch
+```
+
+### Requirements for Development
+
+- **Node.js 20+** (required by AWS SDK v3)
+- **AWS CLI** with configured credentials
+- **AWS account** with CDK bootstrapped
+- All dependencies install automatically via `npm install`
+
+### Testing Changes
+
+```bash
+# After making changes, rebuild
+npm run build
+
+# Test locally in another folder (ie openclaw-aws-test)
+openclaw-aws init
+openclaw-aws deploy
+
+# Or use watch mode for auto-rebuild
+npm run watch
+```
+
+## License
+
+MIT
+
+## Author
+
+Sally Mclean <smclean17@gmail.com>

package/dist/cdk/app.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=app.d.ts.map

package/dist/cdk/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/cdk/app.ts"],"names":[],"mappings":""}

package/dist/cdk/app.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+import * as cdk from 'aws-cdk-lib';
+import { OpenClawStack } from './stack.js';
+import { loadConfigByName } from '../cli/utils/config.js';
+import { getApiKeyParamName, getGatewayTokenParamName } from '../cli/utils/api-keys.js';
+// Load configuration
+let config;
+let configName;
+try {
+    const envConfigName = process.env.OPENCLAW_CONFIG_NAME;
+    if (!envConfigName) {
+        console.error('Error loading configuration: OPENCLAW_CONFIG_NAME is required');
+        process.exit(1);
+    }
+    configName = envConfigName;
+    config = loadConfigByName(configName);
+}
+catch (error) {
+    console.error('Error loading configuration:', error instanceof Error ? error.message : String(error));
+    process.exit(1);
+}
+// Determine API provider from config
+const apiProvider = config.openclaw?.apiProvider || 'anthropic-api-key'; // Default to Anthropic if not set
+const apiKeyParamName = getApiKeyParamName(configName, apiProvider);
+const gatewayTokenParamName = getGatewayTokenParamName(configName);
+// Parse instance type
+function parseInstanceType(type) {
+    const [family, size] = type.split('.');
+    return {
+        class: family.toUpperCase(),
+        size: size.toUpperCase(),
+    };
+}
+// Build stack config
+const stackConfig = {
+    projectName: process.env.OPENCLAW_CONFIG_NAME ?? 'openclaw',
+    instanceName: config.instance.name,
+    instanceType: parseInstanceType(config.instance.type),
+    enableCloudWatchLogs: config.features.cloudWatchLogs,
+    useDefaultVpc: config.network.useDefaultVpc,
+};
+// Get configuration from environment (no model/sandbox in config anymore)
+// Gateway port is fixed in the stack (18789)
+// Create CDK app
+const app = new cdk.App();
+// Build stack props
+const stackProps = {
+    config: stackConfig,
+    apiProvider,
+    apiKeyParamName,
+    gatewayTokenParamName,
+    useDefaultVpc: config.network.useDefaultVpc,
+    env: {
+        region: config.aws.region,
+        account: process.env.CDK_DEFAULT_ACCOUNT,
+    },
+};
+new OpenClawStack(app, config.stack.name, stackProps);
+app.synth();
+//# sourceMappingURL=app.js.map

package/dist/cdk/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/cdk/app.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,GAAG,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,aAAa,EAAsB,MAAM,YAAY,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAGxF,qBAAqB;AACrB,IAAI,MAAM,CAAC;AACX,IAAI,UAAkB,CAAC;AACvB,IAAI,CAAC;IACH,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;IACvD,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAC/E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,UAAU,GAAG,aAAa,CAAC;IAC3B,MAAM,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AACxC,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,OAAO,CAAC,KAAK,CACX,8BAA8B,EAC9B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACvD,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,qCAAqC;AACrC,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,EAAE,WAAW,IAAI,mBAAmB,CAAC,CAAC,kCAAkC;AAE3G,MAAM,eAAe,GAAG,kBAAkB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;AACpE,MAAM,qBAAqB,GAAG,wBAAwB,CAAC,UAAU,CAAC,CAAC;AAEnE,sBAAsB;AACtB,SAAS,iBAAiB,CAAC,IAAY;IACrC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvC,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,WAAW,EAAE;QAC3B,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE;KACzB,CAAC;AACJ,CAAC;AAED,qBAAqB;AACrB,MAAM,WAAW,GAAgB;IAC/B,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,UAAU;IAC3D,YAAY,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;IAClC,YAAY,EAAE,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;IACrD,oBAAoB,EAAE,MAAM,CAAC,QAAQ,CAAC,cAAc;IACpD,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,aAAa;CAC5C,CAAC;AAEF,0EAA0E;AAC1E,6CAA6C;AAE7C,iBAAiB;AACjB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;AAE1B,oBAAoB;AACpB,MAAM,UAAU,GAAuB;IACrC,MAAM,EAAE,WAAW;IACnB,WAAW;IACX,eAAe;IACf,qBAAqB;IACrB,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,aAAa;IAC3C,GAAG,EAAE;QACH,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM;QACzB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB;KACzC;CACF,CAAC;AAEF,IAAI,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAEtD,GAAG,CAAC,KAAK,EAAE,CAAC"}

package/dist/cdk/stack.d.ts

@@ -0,0 +1,16 @@
+import { Stack, StackProps } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import type { StackConfig } from '../cli/types/index.js';
+import type { Provider } from '../cli/types/index.js';
+export interface OpenClawStackProps extends StackProps {
+    config: StackConfig;
+    apiProvider: Provider;
+    apiKeyParamName: string;
+    gatewayTokenParamName: string;
+    useDefaultVpc: boolean;
+}
+export declare class OpenClawStack extends Stack {
+    constructor(scope: Construct, id: string, props: OpenClawStackProps);
+}
+export default OpenClawStack;
+//# sourceMappingURL=stack.d.ts.map

package/dist/cdk/stack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stack.d.ts","sourceRoot":"","sources":["../../src/cdk/stack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,UAAU,EAAa,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAgBvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,QAAQ,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,aAAa,EAAE,OAAO,CAAC;CACxB;AAED,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB;CAsWpE;AAED,eAAe,aAAa,CAAC"}