stacktape 3.5.8 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/.tsconfig.bun-build.json +1 -0
  2. package/ai-docs/cli-ref/aws-profile-create.md +22 -0
  3. package/ai-docs/cli-ref/aws-profile-delete.md +22 -0
  4. package/ai-docs/cli-ref/aws-profile-list.md +20 -0
  5. package/ai-docs/cli-ref/aws-profile-update.md +22 -0
  6. package/ai-docs/cli-ref/bastion-session.md +29 -0
  7. package/ai-docs/cli-ref/bastion-tunnel.md +30 -0
  8. package/ai-docs/cli-ref/bucket-sync.md +30 -0
  9. package/ai-docs/cli-ref/cf-module-update.md +26 -0
  10. package/ai-docs/cli-ref/cf-rollback.md +28 -0
  11. package/ai-docs/cli-ref/codebuild-deploy.md +34 -0
  12. package/ai-docs/cli-ref/compile-template.md +25 -0
  13. package/ai-docs/cli-ref/container-session.md +30 -0
  14. package/ai-docs/cli-ref/debug-alarms.md +28 -0
  15. package/ai-docs/cli-ref/debug-aws-sdk.md +33 -0
  16. package/ai-docs/cli-ref/debug-container-exec.md +36 -0
  17. package/ai-docs/cli-ref/debug-dynamodb.md +35 -0
  18. package/ai-docs/cli-ref/debug-logs.md +34 -0
  19. package/ai-docs/cli-ref/debug-metrics.md +33 -0
  20. package/ai-docs/cli-ref/debug-opensearch.md +35 -0
  21. package/ai-docs/cli-ref/debug-redis.md +36 -0
  22. package/ai-docs/cli-ref/debug-sql.md +35 -0
  23. package/ai-docs/cli-ref/defaults-configure.md +29 -0
  24. package/ai-docs/cli-ref/defaults-list.md +20 -0
  25. package/ai-docs/cli-ref/delete.md +24 -0
  26. package/ai-docs/cli-ref/deploy.md +25 -0
  27. package/ai-docs/cli-ref/deployment-script-run.md +28 -0
  28. package/ai-docs/cli-ref/dev-stop.md +26 -0
  29. package/ai-docs/cli-ref/dev.md +45 -0
  30. package/ai-docs/cli-ref/domain-add.md +26 -0
  31. package/ai-docs/cli-ref/help.md +18 -0
  32. package/ai-docs/cli-ref/info-operations.md +22 -0
  33. package/ai-docs/cli-ref/info-stack.md +30 -0
  34. package/ai-docs/cli-ref/info-stacks.md +26 -0
  35. package/ai-docs/cli-ref/info-whoami.md +22 -0
  36. package/ai-docs/cli-ref/init.md +30 -0
  37. package/ai-docs/cli-ref/login.md +20 -0
  38. package/ai-docs/cli-ref/logout.md +18 -0
  39. package/ai-docs/cli-ref/mcp-add.md +22 -0
  40. package/ai-docs/cli-ref/mcp.md +20 -0
  41. package/ai-docs/cli-ref/org-create.md +24 -0
  42. package/ai-docs/cli-ref/org-delete.md +24 -0
  43. package/ai-docs/cli-ref/org-list.md +22 -0
  44. package/ai-docs/cli-ref/package-workloads.md +25 -0
  45. package/ai-docs/cli-ref/param-get.md +26 -0
  46. package/ai-docs/cli-ref/preview-changes.md +23 -0
  47. package/ai-docs/cli-ref/project-create.md +22 -0
  48. package/ai-docs/cli-ref/projects-list.md +22 -0
  49. package/ai-docs/cli-ref/rollback.md +28 -0
  50. package/ai-docs/cli-ref/script-run.md +29 -0
  51. package/ai-docs/cli-ref/secret-create.md +28 -0
  52. package/ai-docs/cli-ref/secret-delete.md +26 -0
  53. package/ai-docs/cli-ref/secret-get.md +26 -0
  54. package/ai-docs/cli-ref/upgrade.md +20 -0
  55. package/ai-docs/cli-ref/version.md +18 -0
  56. package/ai-docs/concept/connecting-resources.md +369 -0
  57. package/ai-docs/concept/directives.md +371 -0
  58. package/ai-docs/concept/extending-cloudformation.md +315 -0
  59. package/ai-docs/concept/overrides-and-transforms.md +352 -0
  60. package/ai-docs/concept/stages-and-environments.md +347 -0
  61. package/ai-docs/concept/typescript-config.md +447 -0
  62. package/ai-docs/concept/yaml-config.md +338 -0
  63. package/ai-docs/config-ref/_root.md +131 -0
  64. package/ai-docs/config-ref/application-load-balancer.md +1109 -0
  65. package/ai-docs/config-ref/astro-web.md +115 -0
  66. package/ai-docs/config-ref/aws-cdk-construct.md +68 -0
  67. package/ai-docs/config-ref/bastion.md +93 -0
  68. package/ai-docs/config-ref/batch-job.md +179 -0
  69. package/ai-docs/config-ref/bucket.md +348 -0
  70. package/ai-docs/config-ref/cdn.md +496 -0
  71. package/ai-docs/config-ref/custom-resource.md +80 -0
  72. package/ai-docs/config-ref/deployment-script.md +79 -0
  73. package/ai-docs/config-ref/dynamo-db-table.md +202 -0
  74. package/ai-docs/config-ref/edge-lambda-function.md +87 -0
  75. package/ai-docs/config-ref/efs-filesystem.md +72 -0
  76. package/ai-docs/config-ref/event-bus.md +63 -0
  77. package/ai-docs/config-ref/function.md +409 -0
  78. package/ai-docs/config-ref/hosting-bucket.md +171 -0
  79. package/ai-docs/config-ref/http-api-gateway.md +149 -0
  80. package/ai-docs/config-ref/http-endpoint.md +92 -0
  81. package/ai-docs/config-ref/kinesis-stream.md +97 -0
  82. package/ai-docs/config-ref/mongo-db-atlas-cluster.md +254 -0
  83. package/ai-docs/config-ref/multi-container-workload.md +399 -0
  84. package/ai-docs/config-ref/network-load-balancer.md +118 -0
  85. package/ai-docs/config-ref/nextjs-web.md +147 -0
  86. package/ai-docs/config-ref/nuxt-web.md +81 -0
  87. package/ai-docs/config-ref/open-search.md +206 -0
  88. package/ai-docs/config-ref/private-service.md +75 -0
  89. package/ai-docs/config-ref/redis-cluster.md +223 -0
  90. package/ai-docs/config-ref/relational-database.md +525 -0
  91. package/ai-docs/config-ref/remix-web.md +74 -0
  92. package/ai-docs/config-ref/sns-topic.md +69 -0
  93. package/ai-docs/config-ref/solidstart-web.md +75 -0
  94. package/ai-docs/config-ref/sqs-queue-not-empty.md +414 -0
  95. package/ai-docs/config-ref/sqs-queue.md +232 -0
  96. package/ai-docs/config-ref/state-machine.md +235 -0
  97. package/ai-docs/config-ref/sveltekit-web.md +81 -0
  98. package/ai-docs/config-ref/tanstack-web.md +75 -0
  99. package/ai-docs/config-ref/upstash-redis.md +59 -0
  100. package/ai-docs/config-ref/user-auth-pool.md +876 -0
  101. package/ai-docs/config-ref/web-app-firewall.md +212 -0
  102. package/ai-docs/config-ref/web-service.md +178 -0
  103. package/ai-docs/config-ref/worker-service.md +41 -0
  104. package/ai-docs/getting-started/console.md +232 -0
  105. package/ai-docs/getting-started/deployment.md +434 -0
  106. package/ai-docs/getting-started/dev-mode.md +118 -0
  107. package/ai-docs/getting-started/how-it-works.md +119 -0
  108. package/ai-docs/getting-started/intro.md +157 -0
  109. package/ai-docs/getting-started/using-with-ai.md +228 -0
  110. package/ai-docs/getting-started/workflow.md +197 -0
  111. package/ai-docs/index.json +1514 -0
  112. package/ai-docs/recipe/background-jobs.md +183 -0
  113. package/ai-docs/recipe/database-migrations.md +240 -0
  114. package/ai-docs/recipe/graphql-api.md +211 -0
  115. package/ai-docs/recipe/monorepo-setup.md +183 -0
  116. package/ai-docs/recipe/nextjs-full-stack.md +188 -0
  117. package/ai-docs/recipe/rest-api-with-database.md +156 -0
  118. package/ai-docs/recipe/scheduled-tasks.md +186 -0
  119. package/ai-docs/recipe/static-website.md +241 -0
  120. package/ai-docs/troubleshooting/cloudformation-stack-states.md +189 -0
  121. package/bin/stacktape.js +0 -12
  122. package/package.json +1 -1
  123. package/plain.d.ts +372 -111
@@ -0,0 +1 @@
1
+ {"extends":"/home/runner/work/stacktape/stacktape/tsconfig.json","compilerOptions":{"jsx":"preserve","jsxImportSource":"react","customConditions":[]}}
@@ -0,0 +1,22 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: aws-profile:create"
4
+ tags:
5
+ - aws-profile:create
6
+ - aws-profile
7
+ - create
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape aws-profile:create`
13
+
14
+ Creates a new AWS profile on your system.
15
+
16
+ You will be prompted to enter a profile name, AWS Access Key ID, and AWS Secret Access Key. The credentials are stored in the default AWS location in your home directory and can be used by other AWS tools.
17
+
18
+ ## Usage
19
+
20
+ ```bash
21
+ stacktape aws-profile:create
22
+ ```
@@ -0,0 +1,22 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: aws-profile:delete"
4
+ tags:
5
+ - aws-profile:delete
6
+ - aws-profile
7
+ - delete
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape aws-profile:delete`
13
+
14
+ Deletes an AWS profile from your system.
15
+
16
+ You will be prompted to enter the name of the profile to delete.
17
+
18
+ ## Usage
19
+
20
+ ```bash
21
+ stacktape aws-profile:delete
22
+ ```
@@ -0,0 +1,20 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: aws-profile:list"
4
+ tags:
5
+ - aws-profile:list
6
+ - aws-profile
7
+ - list
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape aws-profile:list`
13
+
14
+ Lists all AWS profiles configured on your system.
15
+
16
+ ## Usage
17
+
18
+ ```bash
19
+ stacktape aws-profile:list
20
+ ```
@@ -0,0 +1,22 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: aws-profile:update"
4
+ tags:
5
+ - aws-profile:update
6
+ - aws-profile
7
+ - update
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape aws-profile:update`
13
+
14
+ Updates an existing AWS profile on your system.
15
+
16
+ You will be prompted to enter the profile name and the new credentials.
17
+
18
+ ## Usage
19
+
20
+ ```bash
21
+ stacktape aws-profile:update
22
+ ```
@@ -0,0 +1,29 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: bastion:session"
4
+ tags:
5
+ - bastion:session
6
+ - bastion
7
+ - session
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape bastion:session`
13
+
14
+ Starts an interactive session with a bastion host.
15
+
16
+ Your stack must include a `bastion` resource. If you have multiple bastions, you can specify which one to connect to with the `--bastionResource` argument. The session is established over a secure SSM connection.
17
+
18
+ For more information, refer to the [bastion documentation](https://docs.stacktape.com/bastion-servers/#connecting-to-bastion-interactive-session).
19
+
20
+ ## Required Arguments
21
+
22
+ - `--region`
23
+ - `--stage`
24
+
25
+ ## Usage
26
+
27
+ ```bash
28
+ stacktape bastion:session --region <value> --stage <value>
29
+ ```
@@ -0,0 +1,30 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: bastion:tunnel"
4
+ tags:
5
+ - bastion:tunnel
6
+ - bastion
7
+ - tunnel
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape bastion:tunnel`
13
+
14
+ Creates a secure tunnel to a resource through a bastion host.
15
+
16
+ Your stack must include a `bastion` resource. This is useful for accessing resources in a private VPC. If you have multiple bastions, you can specify one with the `--bastionResource` argument. The command will print the tunneled endpoints to the terminal.
17
+
18
+ For more information, refer to the [bastion tunnel documentation](https://docs.stacktape.com/bastion-servers/#creating-bastion-tunnel).
19
+
20
+ ## Required Arguments
21
+
22
+ - `--region`
23
+ - `--stage`
24
+ - `--resourceName`
25
+
26
+ ## Usage
27
+
28
+ ```bash
29
+ stacktape bastion:tunnel --region <value> --stage <value> --resourceName <value>
30
+ ```
@@ -0,0 +1,30 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: bucket:sync"
4
+ tags:
5
+ - bucket:sync
6
+ - bucket
7
+ - sync
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape bucket:sync`
13
+
14
+ Synchronizes the contents of a local directory with an S3 bucket.
15
+
16
+ You can specify the bucket in two ways:
17
+ - **Using Stacktape configuration:** Provide the `stage` and `resourceName`. Stacktape will identify the bucket from the deployed stack and sync the directory specified in the configuration file.
18
+ - **Using bucket ID:** Provide a valid `bucketId` (AWS physical resource ID or bucket name) and a `sourcePath`.
19
+
20
+ Files in the bucket that are not present in the source directory will be removed.
21
+
22
+ ## Required Arguments
23
+
24
+ - `--region`
25
+
26
+ ## Usage
27
+
28
+ ```bash
29
+ stacktape bucket:sync --region <value>
30
+ ```
@@ -0,0 +1,26 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: cf-module:update"
4
+ tags:
5
+ - cf-module:update
6
+ - cf-module
7
+ - update
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape cf-module:update`
13
+
14
+ Updates AWS CloudFormation infrastructure module private types to the latest compatible version.
15
+
16
+ AWS CloudFormation infrastructure modules are used to integrate third-party services into your stack. If a third-party API changes, use this command to update the modules in your account to the latest version.
17
+
18
+ ## Required Arguments
19
+
20
+ - `--region`
21
+
22
+ ## Usage
23
+
24
+ ```bash
25
+ stacktape cf-module:update --region <value>
26
+ ```
@@ -0,0 +1,28 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: cf:rollback"
4
+ tags:
5
+ - cf:rollback
6
+ - cf
7
+ - rollback
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape cf:rollback`
13
+
14
+ Rolls back the CloudFormation stack to the last known good state.
15
+
16
+ This is useful if a stack update fails and leaves the stack in an `UPDATE_FAILED` or `UPDATE_ROLLBACK_FAILED` state. This uses CloudFormation's native rollback mechanism.
17
+
18
+ For rolling back to a specific previous deployment version, use `rollback` instead.
19
+
20
+ ## Required Arguments
21
+
22
+ - `--region`
23
+
24
+ ## Usage
25
+
26
+ ```bash
27
+ stacktape cf:rollback --region <value>
28
+ ```
@@ -0,0 +1,34 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: codebuild:deploy"
4
+ tags:
5
+ - codebuild:deploy
6
+ - codebuild
7
+ - deploy
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape codebuild:deploy`
13
+
14
+ Deploys your stack to AWS using AWS CodeBuild.
15
+
16
+ This command offloads the deployment process to a dedicated environment within your AWS account, which is useful for resource-intensive projects.
17
+
18
+ Here's how it works:
19
+ 1. Your project is zipped and uploaded to an S3 bucket in your account.
20
+ 2. A CodeBuild environment (a dedicated VM) is provisioned.
21
+ 3. The deployment begins, and logs are streamed to your terminal in real-time.
22
+
23
+ Like the `deploy` command, this requires a `stacktape.yml` file.
24
+
25
+ ## Required Arguments
26
+
27
+ - `--stage`
28
+ - `--region`
29
+
30
+ ## Usage
31
+
32
+ ```bash
33
+ stacktape codebuild:deploy --stage <value> --region <value>
34
+ ```
@@ -0,0 +1,25 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: compile-template"
4
+ tags:
5
+ - compile-template
6
+ source: src/config/cli/commands.ts
7
+ priority: 3
8
+ ---
9
+
10
+ # `stacktape compile-template`
11
+
12
+ Compiles your Stacktape configuration into a CloudFormation template.
13
+
14
+ By default, the template is saved to `./compiled-template.yaml`. Use the `--outFile` option to specify a different path.
15
+
16
+ ## Required Arguments
17
+
18
+ - `--stage`
19
+ - `--region`
20
+
21
+ ## Usage
22
+
23
+ ```bash
24
+ stacktape compile-template --stage <value> --region <value>
25
+ ```
@@ -0,0 +1,30 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: container:session"
4
+ tags:
5
+ - container:session
6
+ - container
7
+ - session
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape container:session`
13
+
14
+ Starts an interactive session inside a deployed container.
15
+
16
+ The session is established using ECS Exec and a secure SSM connection. If your service has multiple containers, you can choose which one to connect to. This is useful for debugging and inspecting running containers.
17
+
18
+ For more information, refer to the [container session documentation](https://docs.stacktape.com/bastion-servers/#connecting-to-bastion-interactive-session).
19
+
20
+ ## Required Arguments
21
+
22
+ - `--region`
23
+ - `--stage`
24
+ - `--resourceName`
25
+
26
+ ## Usage
27
+
28
+ ```bash
29
+ stacktape container:session --region <value> --stage <value> --resourceName <value>
30
+ ```
@@ -0,0 +1,28 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:alarms"
4
+ tags:
5
+ - debug:alarms
6
+ - debug
7
+ - alarms
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:alarms`
13
+
14
+ View CloudWatch alarm states for stack resources.
15
+
16
+ Shows all alarms configured for the stack with their current state (OK, ALARM, INSUFFICIENT_DATA).
17
+ Filter by resource name or alarm state.
18
+
19
+ ## Required Arguments
20
+
21
+ - `--stage`
22
+ - `--region`
23
+
24
+ ## Usage
25
+
26
+ ```bash
27
+ stacktape debug:alarms --stage <value> --region <value>
28
+ ```
@@ -0,0 +1,33 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:aws-sdk"
4
+ tags:
5
+ - debug:aws-sdk
6
+ - debug
7
+ - aws-sdk
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:aws-sdk`
13
+
14
+ Execute read-only AWS SDK commands against deployed resources.
15
+
16
+ Provides direct access to AWS SDK v3 for inspecting deployed resources. Only read-only operations (List*, Get*, Describe*, Head*) are allowed.
17
+
18
+ Examples:
19
+ stacktape debug:aws-sdk --stage prod --service lambda --command ListFunctions
20
+ stacktape debug:aws-sdk --stage prod --service dynamodb --command Scan --input '{"TableName": "my-table", "Limit": 10}'
21
+ stacktape debug:aws-sdk --stage prod --service logs --command FilterLogEvents --input '{"logGroupName": "/aws/lambda/my-func"}'
22
+
23
+ ## Required Arguments
24
+
25
+ - `--region`
26
+ - `--service`
27
+ - `--command`
28
+
29
+ ## Usage
30
+
31
+ ```bash
32
+ stacktape debug:aws-sdk --region <value> --service <value> --command <value>
33
+ ```
@@ -0,0 +1,36 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:container-exec"
4
+ tags:
5
+ - debug:container-exec
6
+ - debug
7
+ - container-exec
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:container-exec`
13
+
14
+ Execute a command in a running container and return the output.
15
+
16
+ Runs a command inside a deployed container workload (web-service, private-service, worker-service, or multi-container-workload) using ECS Exec. The command output is captured and returned as JSON.
17
+
18
+ Use --taskArn to specify which task to connect to when multiple instances are running (defaults to first available). Use --container to specify which container for multi-container workloads.
19
+
20
+ Examples:
21
+ stacktape debug:container-exec --stage prod --resourceName myService --command "ls -la"
22
+ stacktape debug:container-exec --stage prod --resourceName myService --command "cat /app/config.json"
23
+ stacktape debug:container-exec --stage prod --resourceName myService --taskArn abc123 --command "env"
24
+
25
+ ## Required Arguments
26
+
27
+ - `--region`
28
+ - `--stage`
29
+ - `--resourceName`
30
+ - `--command`
31
+
32
+ ## Usage
33
+
34
+ ```bash
35
+ stacktape debug:container-exec --region <value> --stage <value> --resourceName <value> --command <value>
36
+ ```
@@ -0,0 +1,35 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:dynamodb"
4
+ tags:
5
+ - debug:dynamodb
6
+ - debug
7
+ - dynamodb
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:dynamodb`
13
+
14
+ Query a deployed DynamoDB table.
15
+
16
+ Supports operations: scan, query, get, schema, sample. All operations are read-only.
17
+
18
+ Examples:
19
+ stacktape debug:dynamodb --stage prod --resourceName myTable --operation sample
20
+ stacktape debug:dynamodb --stage prod --resourceName myTable --operation schema
21
+ stacktape debug:dynamodb --stage prod --resourceName myTable --operation scan --limit 50
22
+ stacktape debug:dynamodb --stage prod --resourceName myTable --operation query --pk '{"userId": "123"}'
23
+ stacktape debug:dynamodb --stage prod --resourceName myTable --operation get --pk '{"userId": "123"}' --sk '{"timestamp": 1234}'
24
+
25
+ ## Required Arguments
26
+
27
+ - `--region`
28
+ - `--stage`
29
+ - `--resourceName`
30
+
31
+ ## Usage
32
+
33
+ ```bash
34
+ stacktape debug:dynamodb --region <value> --stage <value> --resourceName <value>
35
+ ```
@@ -0,0 +1,34 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:logs"
4
+ tags:
5
+ - debug:logs
6
+ - debug
7
+ - logs
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:logs`
13
+
14
+ Fetch and analyze logs from a deployed resource.
15
+
16
+ Supports two modes:
17
+ - **Standard**: Fetches recent log events with optional filtering
18
+ - **Insights**: Runs CloudWatch Logs Insights query with --query flag
19
+
20
+ Examples:
21
+ stacktape debug:logs --stage prod --resourceName myLambda --startTime "1h"
22
+ stacktape debug:logs --stage prod --resourceName myLambda --query "fields @timestamp, @message | filter @message like /ERROR/"
23
+
24
+ ## Required Arguments
25
+
26
+ - `--stage`
27
+ - `--region`
28
+ - `--resourceName`
29
+
30
+ ## Usage
31
+
32
+ ```bash
33
+ stacktape debug:logs --stage <value> --region <value> --resourceName <value>
34
+ ```
@@ -0,0 +1,33 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:metrics"
4
+ tags:
5
+ - debug:metrics
6
+ - debug
7
+ - metrics
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:metrics`
13
+
14
+ Fetch CloudWatch metrics for a deployed resource.
15
+
16
+ Supported metrics by resource type:
17
+ - Lambda: Invocations, Errors, Duration, Throttles
18
+ - ECS: CPUUtilization, MemoryUtilization
19
+ - RDS: CPUUtilization, DatabaseConnections, FreeStorageSpace
20
+ - API Gateway: Count, 4XXError, 5XXError, Latency
21
+
22
+ ## Required Arguments
23
+
24
+ - `--stage`
25
+ - `--region`
26
+ - `--resourceName`
27
+ - `--metric`
28
+
29
+ ## Usage
30
+
31
+ ```bash
32
+ stacktape debug:metrics --stage <value> --region <value> --resourceName <value> --metric <value>
33
+ ```
@@ -0,0 +1,35 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:opensearch"
4
+ tags:
5
+ - debug:opensearch
6
+ - debug
7
+ - opensearch
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:opensearch`
13
+
14
+ Query a deployed OpenSearch domain.
15
+
16
+ Supports operations: search, get, indices, mapping, count. All operations are read-only.
17
+
18
+ Examples:
19
+ stacktape debug:opensearch --stage prod --resourceName mySearch --operation indices
20
+ stacktape debug:opensearch --stage prod --resourceName mySearch --operation mapping --index users
21
+ stacktape debug:opensearch --stage prod --resourceName mySearch --operation count --index users
22
+ stacktape debug:opensearch --stage prod --resourceName mySearch --operation get --index users --id doc123
23
+ stacktape debug:opensearch --stage prod --resourceName mySearch --operation search --query '{"match_all": {}}'
24
+
25
+ ## Required Arguments
26
+
27
+ - `--region`
28
+ - `--stage`
29
+ - `--resourceName`
30
+
31
+ ## Usage
32
+
33
+ ```bash
34
+ stacktape debug:opensearch --region <value> --stage <value> --resourceName <value>
35
+ ```
@@ -0,0 +1,36 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:redis"
4
+ tags:
5
+ - debug:redis
6
+ - debug
7
+ - redis
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:redis`
13
+
14
+ Query a deployed Redis cluster.
15
+
16
+ Supports operations: keys, get, ttl, info, type. All operations are read-only.
17
+
18
+ If the Redis cluster is VPC-only, use --bastionResource to tunnel through a bastion host.
19
+
20
+ Examples:
21
+ stacktape debug:redis --stage prod --resourceName myRedis --operation info
22
+ stacktape debug:redis --stage prod --resourceName myRedis --operation keys --pattern "user:*"
23
+ stacktape debug:redis --stage prod --resourceName myRedis --operation get --key "session:abc123"
24
+ stacktape debug:redis --stage prod --resourceName myRedis --bastionResource myBastion --operation info
25
+
26
+ ## Required Arguments
27
+
28
+ - `--region`
29
+ - `--stage`
30
+ - `--resourceName`
31
+
32
+ ## Usage
33
+
34
+ ```bash
35
+ stacktape debug:redis --region <value> --stage <value> --resourceName <value>
36
+ ```
@@ -0,0 +1,35 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: debug:sql"
4
+ tags:
5
+ - debug:sql
6
+ - debug
7
+ - sql
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape debug:sql`
13
+
14
+ Execute read-only SQL queries against a deployed relational database.
15
+
16
+ Supports PostgreSQL and MySQL databases. Only read-only queries (SELECT, SHOW, DESCRIBE, EXPLAIN) are allowed.
17
+
18
+ If the database is VPC-only, use --bastionResource to tunnel through a bastion host.
19
+
20
+ Examples:
21
+ stacktape debug:sql --stage prod --resourceName myDatabase --sql "SELECT * FROM users LIMIT 10"
22
+ stacktape debug:sql --stage prod --resourceName myDatabase --bastionResource myBastion --sql "SHOW TABLES"
23
+
24
+ ## Required Arguments
25
+
26
+ - `--region`
27
+ - `--stage`
28
+ - `--resourceName`
29
+ - `--sql`
30
+
31
+ ## Usage
32
+
33
+ ```bash
34
+ stacktape debug:sql --region <value> --stage <value> --resourceName <value> --sql <value>
35
+ ```
@@ -0,0 +1,29 @@
1
+ ---
2
+ docType: cli-ref
3
+ title: "CLI: defaults:configure"
4
+ tags:
5
+ - defaults:configure
6
+ - defaults
7
+ - configure
8
+ source: src/config/cli/commands.ts
9
+ priority: 3
10
+ ---
11
+
12
+ # `stacktape defaults:configure`
13
+
14
+ Sets system-wide default arguments for Stacktape commands.
15
+
16
+ You can set defaults for:
17
+ - `region`
18
+ - `stage`
19
+ - `awsProfile`
20
+ - `projectName`
21
+ - `awsAccount`
22
+
23
+ You can also configure default executables for resolving Node.js directives.
24
+
25
+ ## Usage
26
+
27
+ ```bash
28
+ stacktape defaults:configure
29
+ ```