stacktape 3.5.7 → 3.6.0-beta.0

package/ai-docs/cli-ref/defaults-list.md

@@ -0,0 +1,20 @@
+---
+docType: cli-ref
+title: "CLI: defaults:list"
+tags:
+  - defaults:list
+  - defaults
+  - list
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape defaults:list`
+
+Prints all configured system-wide Stacktape defaults.
+
+## Usage
+
+```bash
+stacktape defaults:list
+```

package/ai-docs/cli-ref/delete.md

@@ -0,0 +1,24 @@
+---
+docType: cli-ref
+title: "CLI: delete"
+tags:
+  - delete
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape delete`
+
+Deletes your stack from AWS.
+
+This action is irreversible and will permanently remove all resources in the stack. Be sure to back up any data you want to keep. If you don't provide a configuration file, `beforeDelete` hooks will not be executed.
+
+## Required Arguments
+
+- `--region`
+
+## Usage
+
+```bash
+stacktape delete --region <value>
+```

package/ai-docs/cli-ref/deploy.md

@@ -0,0 +1,25 @@
+---
+docType: cli-ref
+title: "CLI: deploy"
+tags:
+  - deploy
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape deploy`
+
+Deploys your stack to AWS.
+
+If the stack doesn't exist, it creates a new one. If it already exists, it updates it. This command requires a valid Stacktape configuration file (`stacktape.yml`) in the current directory, or you can specify a path using the `--configPath` option.
+
+## Required Arguments
+
+- `--stage`
+- `--region`
+
+## Usage
+
+```bash
+stacktape deploy --stage <value> --region <value>
+```

package/ai-docs/cli-ref/deployment-script-run.md

@@ -0,0 +1,28 @@
+---
+docType: cli-ref
+title: "CLI: deployment-script:run"
+tags:
+  - deployment-script:run
+  - deployment-script
+  - run
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape deployment-script:run`
+
+Runs a deployment script defined in your configuration.
+
+This command only updates the script's source code. To update environment variables or other configurations, use the `deploy` command.
+
+## Required Arguments
+
+- `--stage`
+- `--region`
+- `--resourceName`
+
+## Usage
+
+```bash
+stacktape deployment-script:run --stage <value> --region <value> --resourceName <value>
+```

package/ai-docs/cli-ref/dev-stop.md

@@ -0,0 +1,26 @@
+---
+docType: cli-ref
+title: "CLI: dev:stop"
+tags:
+  - dev:stop
+  - dev
+  - stop
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape dev:stop`
+
+Stops a running dev agent.
+
+Use this command to gracefully stop a dev agent that was started with `dev --agent`.
+
+If multiple agents are running, you'll be prompted to specify which one to stop using `--agentPort`.
+
+Use `--cleanupContainers` to remove orphaned Docker containers left behind by crashed dev sessions.
+
+## Usage
+
+```bash
+stacktape dev:stop
+```

package/ai-docs/cli-ref/dev.md

@@ -0,0 +1,45 @@
+---
+docType: cli-ref
+title: "CLI: dev"
+tags:
+  - dev
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape dev`
+
+Runs your application locally for development and debugging.
+
+Supports two modes (use `--devMode` to select):
+
+#### Normal mode (default):
+- Deploys a minimal "dev stack" to AWS with only essential infrastructure (IAM roles, secrets).
+- Runs workloads (containers, functions) locally on your machine.
+- Emulates databases (PostgreSQL, MySQL, DynamoDB) and Redis locally using Docker.
+- Automatically sets up tunnels so AWS Lambda functions can reach your local databases.
+- No need for a pre-deployed stack - creates one automatically if needed.
+
+#### Legacy mode (`--devMode legacy`):
+- Requires an already deployed stack.
+- Runs selected workloads locally while connecting to deployed AWS resources.
+- No local database emulation - uses deployed databases directly.
+- Useful when you need to test against production-like data.
+
+#### Common features:
+- Interactive resource picker (or use `--resources` to specify).
+- Hot-reload: type a number + enter to rebuild a workload, or `a` + enter to rebuild all.
+- Automatic file watching with `--watch` flag.
+- Injects environment variables, secrets, and AWS credentials into local workloads.
+- Streams logs from all running workloads to the console.
+
+## Required Arguments
+
+- `--region`
+- `--stage`
+
+## Usage
+
+```bash
+stacktape dev --region <value> --stage <value>
+```

package/ai-docs/cli-ref/domain-add.md

@@ -0,0 +1,26 @@
+---
+docType: cli-ref
+title: "CLI: domain:add"
+tags:
+  - domain:add
+  - domain
+  - add
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape domain:add`
+
+Adds a domain to your AWS account.
+
+Once added, the domain and its subdomains can be used with various resources, such as Web Services, Hosting Buckets, and API Gateways. Before adding a domain, please review the [Domains and Certificates documentation](https://docs.stacktape.com/other-resources/domains-and-certificates/#adding-domain).
+
+## Required Arguments
+
+- `--region`
+
+## Usage
+
+```bash
+stacktape domain:add --region <value>
+```

package/ai-docs/cli-ref/help.md

@@ -0,0 +1,18 @@
+---
+docType: cli-ref
+title: "CLI: help"
+tags:
+  - help
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape help`
+
+Displays help information for commands and their options.
+
+## Usage
+
+```bash
+stacktape help
+```

package/ai-docs/cli-ref/info-operations.md

@@ -0,0 +1,22 @@
+---
+docType: cli-ref
+title: "CLI: info:operations"
+tags:
+  - info:operations
+  - info
+  - operations
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape info:operations`
+
+Lists recent deployment operations (deploy, delete) with their status.
+
+Shows operation history including success/failure status, timestamps, and error descriptions for failed operations. Filter by project or stage to narrow results.
+
+## Usage
+
+```bash
+stacktape info:operations
+```

package/ai-docs/cli-ref/info-stack.md

@@ -0,0 +1,30 @@
+---
+docType: cli-ref
+title: "CLI: info:stack"
+tags:
+  - info:stack
+  - info
+  - stack
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape info:stack`
+
+Displays detailed information about a deployed stack including outputs and resources.
+
+Returns stack outputs (URLs, endpoints, resource identifiers) and the list of AWS resources in the stack. Useful for discovering endpoints after deployment.
+
+You can identify the stack in two ways:
+- Using --stackName directly (e.g., --stackName my-project-prod)
+- Using --projectName and --stage (e.g., --projectName my-project --stage prod)
+
+## Required Arguments
+
+- `--region`
+
+## Usage
+
+```bash
+stacktape info:stack --region <value>
+```

package/ai-docs/cli-ref/info-stacks.md

@@ -0,0 +1,26 @@
+---
+docType: cli-ref
+title: "CLI: info:stacks"
+tags:
+  - info:stacks
+  - info
+  - stacks
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape info:stacks`
+
+Lists all stacks deployed in a specified region.
+
+Shows stack name, status, last update time, creation time, and estimated spend. Useful for discovering what's deployed in your AWS account.
+
+## Required Arguments
+
+- `--region`
+
+## Usage
+
+```bash
+stacktape info:stacks --region <value>
+```

package/ai-docs/cli-ref/info-whoami.md

@@ -0,0 +1,22 @@
+---
+docType: cli-ref
+title: "CLI: info:whoami"
+tags:
+  - info:whoami
+  - info
+  - whoami
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape info:whoami`
+
+Displays information about the current user, organization, connected AWS accounts, and accessible projects.
+
+Use this command to verify your API key is configured correctly and to see what resources you have access to.
+
+## Usage
+
+```bash
+stacktape info:whoami
+```

package/ai-docs/cli-ref/init.md

@@ -0,0 +1,30 @@
+---
+docType: cli-ref
+title: "CLI: init"
+tags:
+  - init
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape init`
+
+Initializes a new Stacktape project and guides you through deployment.
+
+By default, runs an interactive wizard that:
+1. Analyzes your project with AI and generates a configuration
+2. Helps you sign up or log in to Stacktape
+3. Connects your AWS account
+4. Creates a project and optionally sets up CI/CD
+5. Offers to deploy immediately
+
+Alternative modes:
+- **Starter project:** Use `--starterProject` or `--starterId` to initialize from a pre-configured template.
+- **Legacy AI-only:** Use `--useAi` for just the AI config generation without the full wizard.
+- **Template:** Use `--templateId` to fetch a template from the Stacktape console.
+
+## Usage
+
+```bash
+stacktape init
+```

package/ai-docs/cli-ref/login.md

@@ -0,0 +1,20 @@
+---
+docType: cli-ref
+title: "CLI: login"
+tags:
+  - login
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape login`
+
+Configures your Stacktape API key for the current system.
+
+All subsequent operations will be associated with the user and organization linked to this API key. You can get your API key from the [Stacktape console](https://console.stacktape.com/api-keys). You can provide the key with the `--apiKey` option or enter it interactively.
+
+## Usage
+
+```bash
+stacktape login
+```

package/ai-docs/cli-ref/logout.md

@@ -0,0 +1,18 @@
+---
+docType: cli-ref
+title: "CLI: logout"
+tags:
+  - logout
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape logout`
+
+Removes the Stacktape API key from the current system.
+
+## Usage
+
+```bash
+stacktape logout
+```

package/ai-docs/cli-ref/mcp-add.md

@@ -0,0 +1,22 @@
+---
+docType: cli-ref
+title: "CLI: mcp:add"
+tags:
+  - mcp:add
+  - mcp
+  - add
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape mcp:add`
+
+Installs Stacktape MCP server config into popular coding-agent clients on this machine.
+
+Detects client config files (Claude Code, Codex, Cursor, VS Code/Copilot, OpenCode, Windsurf), then adds or updates a `stacktape` MCP server entry that runs `stacktape mcp`. Creates timestamped backups before modifying existing files.
+
+## Usage
+
+```bash
+stacktape mcp:add
+```

package/ai-docs/cli-ref/mcp.md

@@ -0,0 +1,20 @@
+---
+docType: cli-ref
+title: "CLI: mcp"
+tags:
+  - mcp
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape mcp`
+
+Starts a local MCP (Model Context Protocol) server that provides Stacktape tools and documentation to AI coding agents.
+
+The server communicates over stdio using the MCP protocol. It is spawned by MCP-compatible clients (Claude Code, Cursor, etc.) and provides tools for searching Stacktape docs, managing deployments, and debugging infrastructure.
+
+## Usage
+
+```bash
+stacktape mcp
+```

package/ai-docs/cli-ref/org-create.md

@@ -0,0 +1,24 @@
+---
+docType: cli-ref
+title: "CLI: org:create"
+tags:
+  - org:create
+  - org
+  - create
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape org:create`
+
+Creates a new organization in your Stacktape account.
+
+In interactive mode, you'll be prompted for the organization name. In agent mode, provide --organizationName.
+
+The command returns a new API key scoped to the newly created organization.
+
+## Usage
+
+```bash
+stacktape org:create
+```

package/ai-docs/cli-ref/org-delete.md

@@ -0,0 +1,24 @@
+---
+docType: cli-ref
+title: "CLI: org:delete"
+tags:
+  - org:delete
+  - org
+  - delete
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape org:delete`
+
+Deletes organization access for your user.
+
+In interactive mode, you'll pick an organization. In agent mode, provide --organizationId.
+
+This operation is allowed only for organization OWNER and only when there are no other non-service users and no active connected AWS accounts.
+
+## Usage
+
+```bash
+stacktape org:delete
+```

package/ai-docs/cli-ref/org-list.md

@@ -0,0 +1,22 @@
+---
+docType: cli-ref
+title: "CLI: org:list"
+tags:
+  - org:list
+  - org
+  - list
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape org:list`
+
+Lists organizations accessible with your current Stacktape user.
+
+Shows organization name, role, number of connected AWS accounts, and whether it's the current organization for your API key.
+
+## Usage
+
+```bash
+stacktape org:list
+```

package/ai-docs/cli-ref/package-workloads.md

@@ -0,0 +1,25 @@
+---
+docType: cli-ref
+title: "CLI: package-workloads"
+tags:
+  - package-workloads
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape package-workloads`
+
+Packages your compute resources and prepares them for deployment.
+
+This is useful for inspecting the packaged artifacts before deploying.
+
+## Required Arguments
+
+- `--stage`
+- `--region`
+
+## Usage
+
+```bash
+stacktape package-workloads --stage <value> --region <value>
+```

package/ai-docs/cli-ref/param-get.md

@@ -0,0 +1,26 @@
+---
+docType: cli-ref
+title: "CLI: param:get"
+tags:
+  - param:get
+  - param
+  - get
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape param:get`
+
+Retrieves a specified parameter from a resource in a deployed stack.
+
+## Required Arguments
+
+- `--region`
+- `--resourceName`
+- `--paramName`
+
+## Usage
+
+```bash
+stacktape param:get --region <value> --resourceName <value> --paramName <value>
+```

package/ai-docs/cli-ref/preview-changes.md

@@ -0,0 +1,23 @@
+---
+docType: cli-ref
+title: "CLI: preview-changes"
+tags:
+  - preview-changes
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape preview-changes`
+
+Shows a preview of the changes that will be made to your stack if you deploy the current configuration.
+
+## Required Arguments
+
+- `--stage`
+- `--region`
+
+## Usage
+
+```bash
+stacktape preview-changes --stage <value> --region <value>
+```

package/ai-docs/cli-ref/project-create.md

@@ -0,0 +1,22 @@
+---
+docType: cli-ref
+title: "CLI: project:create"
+tags:
+  - project:create
+  - project
+  - create
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape project:create`
+
+Creates a new project in the current organization.
+
+If you omit --projectName in interactive mode, you'll be prompted for it. In agent mode, provide --projectName.
+
+## Usage
+
+```bash
+stacktape project:create
+```

package/ai-docs/cli-ref/projects-list.md

@@ -0,0 +1,22 @@
+---
+docType: cli-ref
+title: "CLI: projects:list"
+tags:
+  - projects:list
+  - projects
+  - list
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape projects:list`
+
+Lists all projects in your organization with their deployed stages, status, and costs.
+
+Shows each project with its stages, deployment status (in-progress, errored, etc.), and current/previous month costs. Useful for getting an overview of your deployments.
+
+## Usage
+
+```bash
+stacktape projects:list
+```

package/ai-docs/cli-ref/rollback.md

@@ -0,0 +1,28 @@
+---
+docType: cli-ref
+title: "CLI: rollback"
+tags:
+  - rollback
+source: src/config/cli/commands.ts
+priority: 3
+---
+
+# `stacktape rollback`
+
+Rolls back the stack to a previous deployment version.
+
+Downloads the CloudFormation template from a previous version and deploys it. Artifacts (Lambda zips, container images) from that version are reused — no rebuild is required.
+
+Use `--listVersions` to see available versions. Specify a target with `--targetVersion v000003` or `--rollbackSteps N` (default: 1).
+
+For recovering from `UPDATE_FAILED` state, use `cf:rollback` instead.
+
+## Required Arguments
+
+- `--region`
+
+## Usage
+
+```bash
+stacktape rollback --region <value>
+```